Skip to content

Commit fc8ac2d

Browse files
Update documentation (#543)
Co-authored-by: daniil-quix <133032822+daniil-quix@users.noreply.github.com>
1 parent 3b1d160 commit fc8ac2d

File tree

10 files changed

+4765
-4765
lines changed

10 files changed

+4765
-4765
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/3.0.0-docs/quixstreams/app.py#L63)
13+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L63)
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/3.0.0-docs/quixstreams/app.py#L101)
88+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L101)
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/3.0.0-docs/quixstreams/app.py#L356)
177+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L356)
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/3.0.0-docs/quixstreams/app.py#L371)
200+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L371)
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/3.0.0-docs/quixstreams/app.py#L451)
282+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L451)
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/3.0.0-docs/quixstreams/app.py#L506)
338+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L506)
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/3.0.0-docs/quixstreams/app.py#L551)
365+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L551)
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/3.0.0-docs/quixstreams/app.py#L581)
400+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L581)
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/3.0.0-docs/quixstreams/app.py#L631)
457+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L631)
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/3.0.0-docs/quixstreams/app.py#L637)
471+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L637)
472472

473473
Add a source to the application.
474474

@@ -494,7 +494,7 @@ Default: the source default
494494
def run(dataframe: Optional[StreamingDataFrame] = None)
495495
```
496496

497-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/3.0.0-docs/quixstreams/app.py#L658)
497+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L658)
498498

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

@@ -530,7 +530,7 @@ app.run()
530530
def setup_topics()
531531
```
532532

533-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/3.0.0-docs/quixstreams/app.py#L780)
533+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L780)
534534

535535
Validate and create the topics
536536

@@ -542,7 +542,7 @@ Validate and create the topics
542542
class ApplicationConfig(BaseSettings)
543543
```
544544

545-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/3.0.0-docs/quixstreams/app.py#L956)
545+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L956)
546546

547547
Immutable object holding the application configuration
548548

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

568-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/3.0.0-docs/quixstreams/app.py#L991)
568+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L991)
569569

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

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

582-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/3.0.0-docs/quixstreams/app.py#L1004)
582+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1004)
583583

584584
Update the application config and return a copy
585585

docs/api-reference/context.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
def set_message_context(context: Optional[MessageContext])
1313
```
1414

15-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/3.0.0-docs/quixstreams/context.py#L20)
15+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/context.py#L20)
1616

1717
Set a MessageContext for the current message in the given `contextvars.Context`
1818

@@ -55,7 +55,7 @@ sdf = sdf.update(lambda value: alter_context(value))
5555
def message_context() -> MessageContext
5656
```
5757

58-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/3.0.0-docs/quixstreams/context.py#L51)
58+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/context.py#L51)
5959

6060
Get a MessageContext for the current message, which houses most of the message
6161

0 commit comments

Comments
 (0)