Skip to content

Commit e02de01

Browse files
github-actions[bot]daniil-quix
github-actions[bot]
and
daniil-quix
authored
Update documentation (#521)
Co-authored-by: daniil-quix <133032822+daniil-quix@users.noreply.github.com>
1 parent ee5388f commit e02de01

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

‎docs/api-reference/application.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ def Quix(
196196
) -> Self
197197
```
198198

199-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L350)
199+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L353)
200200

201201
>***NOTE:*** DEPRECATED: use Application with `quix_sdk_token` argument instead.
202202

@@ -307,7 +307,7 @@ def topic(name: str,
307307
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
308308
```
309309

310-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L491)
310+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L494)
311311

312312
Create a topic definition.
313313

@@ -389,7 +389,7 @@ def dataframe(topic: Optional[Topic] = None,
389389
source: Optional[BaseSource] = None) -> StreamingDataFrame
390390
```
391391

392-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L571)
392+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L574)
393393

394394
A simple helper method that generates a `StreamingDataFrame`, which is used
395395

@@ -439,7 +439,7 @@ to be used as an input topic.
439439
def stop(fail: bool = False)
440440
```
441441

442-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L617)
442+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L620)
443443

444444
Stop the internal poll loop and the message processing.
445445

@@ -466,7 +466,7 @@ to unhandled exception, and it shouldn't commit the current checkpoint.
466466
def get_producer() -> Producer
467467
```
468468

469-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L662)
469+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L665)
470470

471471
Create and return a pre-configured Producer instance.
472472
The Producer is initialized with params passed to Application.
@@ -501,7 +501,7 @@ with app.get_producer() as producer:
501501
def get_consumer(auto_commit_enable: bool = True) -> Consumer
502502
```
503503

504-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L692)
504+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L695)
505505

506506
Create and return a pre-configured Consumer instance.
507507

@@ -558,7 +558,7 @@ with app.get_consumer() as consumer:
558558
def clear_state()
559559
```
560560

561-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L742)
561+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L745)
562562

563563
Clear the state of the application.
564564

@@ -572,7 +572,7 @@ Clear the state of the application.
572572
def add_source(source: BaseSource, topic: Optional[Topic] = None) -> Topic
573573
```
574574

575-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L748)
575+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L751)
576576

577577
Add a source to the application.
578578

@@ -596,7 +596,7 @@ Default: the source default
596596
def run(dataframe: StreamingDataFrame)
597597
```
598598

599-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L767)
599+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L770)
600600

601601
Start processing data from Kafka using provided `StreamingDataFrame`
602602

@@ -638,7 +638,7 @@ app.run(dataframe=df)
638638
def setup_topics()
639639
```
640640

641-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L887)
641+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L890)
642642

643643
Validate and create the topics
644644

@@ -650,7 +650,7 @@ Validate and create the topics
650650
class ApplicationConfig(BaseSettings)
651651
```
652652

653-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1063)
653+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1066)
654654

655655
Immutable object holding the application configuration
656656

@@ -673,7 +673,7 @@ def settings_customise_sources(
673673
) -> Tuple[PydanticBaseSettingsSource, ...]
674674
```
675675

676-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1097)
676+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1101)
677677

678678
Included to ignore reading/setting values from the environment
679679

@@ -687,7 +687,7 @@ Included to ignore reading/setting values from the environment
687687
def copy(**kwargs) -> Self
688688
```
689689

690-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1110)
690+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1114)
691691

692692
Update the application config and return a copy
693693

‎docs/api-reference/quixstreams.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8659,7 +8659,7 @@ def Quix(
86598659
) -> Self
86608660
```
86618661

8662-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L350)
8662+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L353)
86638663

86648664
>***NOTE:*** DEPRECATED: use Application with `quix_sdk_token` argument instead.
86658665

@@ -8762,7 +8762,7 @@ def topic(name: str,
87628762
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
87638763
```
87648764

8765-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L491)
8765+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L494)
87668766

87678767
Create a topic definition.
87688768

@@ -8834,7 +8834,7 @@ def dataframe(topic: Optional[Topic] = None,
88348834
source: Optional[BaseSource] = None) -> StreamingDataFrame
88358835
```
88368836

8837-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L571)
8837+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L574)
88388838

88398839
A simple helper method that generates a `StreamingDataFrame`, which is used
88408840

@@ -8876,7 +8876,7 @@ to be used as an input topic.
88768876
def stop(fail: bool = False)
88778877
```
88788878

8879-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L617)
8879+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L620)
88808880

88818881
Stop the internal poll loop and the message processing.
88828882

@@ -8899,7 +8899,7 @@ to unhandled exception, and it shouldn't commit the current checkpoint.
88998899
def get_producer() -> Producer
89008900
```
89018901

8902-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L662)
8902+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L665)
89038903

89048904
Create and return a pre-configured Producer instance.
89058905
The Producer is initialized with params passed to Application.
@@ -8930,7 +8930,7 @@ with app.get_producer() as producer:
89308930
def get_consumer(auto_commit_enable: bool = True) -> Consumer
89318931
```
89328932

8933-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L692)
8933+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L695)
89348934

89358935
Create and return a pre-configured Consumer instance.
89368936

@@ -8981,7 +8981,7 @@ Default - True
89818981
def clear_state()
89828982
```
89838983

8984-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L742)
8984+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L745)
89858985

89868986
Clear the state of the application.
89878987

@@ -8993,7 +8993,7 @@ Clear the state of the application.
89938993
def add_source(source: BaseSource, topic: Optional[Topic] = None) -> Topic
89948994
```
89958995

8996-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L748)
8996+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L751)
89978997

89988998
Add a source to the application.
89998999

@@ -9013,7 +9013,7 @@ Default: the source default
90139013
def run(dataframe: StreamingDataFrame)
90149014
```
90159015

9016-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L767)
9016+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L770)
90179017

90189018
Start processing data from Kafka using provided `StreamingDataFrame`
90199019

@@ -9049,7 +9049,7 @@ app.run(dataframe=df)
90499049
def setup_topics()
90509050
```
90519051

9052-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L887)
9052+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L890)
90539053

90549054
Validate and create the topics
90559055

@@ -9061,7 +9061,7 @@ Validate and create the topics
90619061
class ApplicationConfig(BaseSettings)
90629062
```
90639063

9064-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1063)
9064+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1066)
90659065

90669066
Immutable object holding the application configuration
90679067

@@ -9082,7 +9082,7 @@ def settings_customise_sources(
90829082
) -> Tuple[PydanticBaseSettingsSource, ...]
90839083
```
90849084

9085-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1097)
9085+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1101)
90869086

90879087
Included to ignore reading/setting values from the environment
90889088

@@ -9094,7 +9094,7 @@ Included to ignore reading/setting values from the environment
90949094
def copy(**kwargs) -> Self
90959095
```
90969096

9097-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1110)
9097+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1114)
90989098

90999099
Update the application config and return a copy
91009100

0 commit comments

Comments
 (0)