Skip to content

Commit b36cc94

Browse files
Update documentation (#525)
Co-authored-by: daniil-quix <133032822+daniil-quix@users.noreply.github.com>
1 parent 389b1be commit b36cc94

File tree

10 files changed

+613
-613
lines changed

10 files changed

+613
-613
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/chore/reorganize-connectors/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

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

87-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L101)
87+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L101)
8888

8989

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

176-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L355)
176+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L355)
177177

178178
RAISES EXCEPTION: DEPRECATED.
179179

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

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

201201
Create a topic definition.
202202

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

281-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L450)
281+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L450)
282282

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

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

337-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L505)
337+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L505)
338338

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

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

364-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L550)
364+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L550)
365365

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

399-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L580)
399+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L580)
400400

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

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

456-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L630)
456+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L630)
457457

458458
Clear the state of the application.
459459

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

470-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L636)
470+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L636)
471471

472472
Add a source to the application.
473473

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

496-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L657)
496+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L657)
497497

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

@@ -529,7 +529,7 @@ app.run()
529529
def setup_topics()
530530
```
531531

532-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L779)
532+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L779)
533533

534534
Validate and create the topics
535535

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

544-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L955)
544+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L955)
545545

546546
Immutable object holding the application configuration
547547

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

567-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L990)
567+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L990)
568568

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

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

581-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/chore/reorganize-connectors/quixstreams/app.py#L1003)
581+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/app.py#L1003)
582582

583583
Update the application config and return a copy
584584

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/chore/reorganize-connectors/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/chore/reorganize-connectors/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)