Skip to content

Commit 6f7938f

Browse files
Update documentation (#782)
Co-authored-by: daniil-quix <133032822+daniil-quix@users.noreply.github.com>
1 parent f6ef42b commit 6f7938f

File tree

4 files changed

+383
-288
lines changed

4 files changed

+383
-288
lines changed

docs/api-reference/application.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
class Application()
1111
```
1212

13-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L79)
13+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L80)
1414

1515
The main Application class.
1616

@@ -85,7 +85,7 @@ def __init__(broker_address: Optional[Union[str, ConnectionConfig]] = None,
8585
processing_guarantee: ProcessingGuarantee = "at-least-once")
8686
```
8787

88-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L117)
88+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L118)
8989

9090

9191
<br>
@@ -174,7 +174,7 @@ instead of the default one.
174174
def Quix(cls, *args, **kwargs)
175175
```
176176

177-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L361)
177+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L364)
178178

179179
RAISES EXCEPTION: DEPRECATED.
180180

@@ -197,7 +197,7 @@ def topic(name: str,
197197
timestamp_extractor: Optional[TimestampExtractor] = None) -> Topic
198198
```
199199

200-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L393)
200+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L396)
201201

202202
Create a topic definition.
203203

@@ -279,7 +279,7 @@ def dataframe(topic: Optional[Topic] = None,
279279
source: Optional[BaseSource] = None) -> StreamingDataFrame
280280
```
281281

282-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L473)
282+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L476)
283283

284284
A simple helper method that generates a `StreamingDataFrame`, which is used
285285

@@ -335,7 +335,7 @@ to be used as an input topic.
335335
def stop(fail: bool = False)
336336
```
337337

338-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L529)
338+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L532)
339339

340340
Stop the internal poll loop and the message processing.
341341

@@ -362,7 +362,7 @@ to unhandled exception, and it shouldn't commit the current checkpoint.
362362
def get_producer() -> Producer
363363
```
364364

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

367367
Create and return a pre-configured Producer instance.
368368
The Producer is initialized with params passed to Application.
@@ -397,7 +397,7 @@ with app.get_producer() as producer:
397397
def get_consumer(auto_commit_enable: bool = True) -> Consumer
398398
```
399399

400-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L629)
400+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L632)
401401

402402
Create and return a pre-configured Consumer instance.
403403

@@ -454,7 +454,7 @@ with app.get_consumer() as consumer:
454454
def clear_state()
455455
```
456456

457-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L679)
457+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L682)
458458

459459
Clear the state of the application.
460460

@@ -468,7 +468,7 @@ Clear the state of the application.
468468
def add_source(source: BaseSource, topic: Optional[Topic] = None) -> Topic
469469
```
470470

471-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L685)
471+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L688)
472472

473473
Add a source to the application.
474474

@@ -495,7 +495,7 @@ Note: the names of default topics are prefixed with "source__".
495495
def run(dataframe: Optional[StreamingDataFrame] = None)
496496
```
497497

498-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L718)
498+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L721)
499499

500500
Start processing data from Kafka using provided `StreamingDataFrame`
501501

@@ -531,7 +531,7 @@ app.run()
531531
def setup_topics()
532532
```
533533

534-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L843)
534+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L846)
535535

536536
Validate the application topics
537537

@@ -543,7 +543,7 @@ Validate the application topics
543543
class ApplicationConfig(BaseSettings)
544544
```
545545

546-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1025)
546+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1014)
547547

548548
Immutable object holding the application configuration
549549

@@ -566,7 +566,7 @@ def settings_customise_sources(
566566
) -> Tuple[PydanticBaseSettingsSource, ...]
567567
```
568568

569-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1060)
569+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1049)
570570

571571
Included to ignore reading/setting values from the environment
572572

@@ -580,7 +580,7 @@ Included to ignore reading/setting values from the environment
580580
def copy(**kwargs) -> Self
581581
```
582582

583-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1073)
583+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1062)
584584

585585
Update the application config and return a copy
586586

0 commit comments

Comments
 (0)