You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
build(#1430): separate cli faststream to its own distribution (#1769)
* build(#1430): separate cli faststream to its own distribution
* ci: add cli target to smoke job tests
* docs: mentioned fastream cli distribution on documnetation and README
* Update faststream.md
* chore: restrict watchfiles version
* chore: bump version
---------
Co-authored-by: Kumaran Rajendhiran <kumaran@airt.ai>
Co-authored-by: Pastukhov Nikita <nikita@pastukhov-dev.ru>
Co-authored-by: Nikita Pastukhov <diementros@yandex.ru>
Copy file name to clipboardexpand all lines: README.md
+6
Original file line number
Diff line number
Diff line change
@@ -200,6 +200,12 @@ async def test_invalid():
200
200
201
201
The application can be started using built-in **FastStream** CLI command.
202
202
203
+
Before running the service, install **FastStream CLI** using the following command:
204
+
205
+
```shell
206
+
pip install "faststream[cli]"
207
+
```
208
+
203
209
To run the service, use the **FastStream CLI** command and pass the module (in this case, the file where the app implementation is located) and the app symbol to the command.
Copy file name to clipboardexpand all lines: docs/docs/en/faststream.md
+6
Original file line number
Diff line number
Diff line change
@@ -141,6 +141,12 @@ Using pytest, the test for our service would look like this:
141
141
142
142
The application can be started using the built-in **FastStream** CLI command.
143
143
144
+
!!! note
145
+
Before running the service, install **FastStream CLI** using the following command:
146
+
```shell
147
+
pip install "faststream[cli]"
148
+
```
149
+
144
150
To run the service, use the **FastStream CLI** command and pass the module (in this case, the file where the app implementation is located) and the app symbol to the command.
Copy file name to clipboardexpand all lines: docs/docs/en/getting-started/cli/index.md
+10
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,16 @@ search:
15
15
!!! quote ""
16
16
Thanks to [*typer*](https://typer.tiangolo.com/){.external-link target="_blank"} and [*watchfiles*](https://watchfiles.helpmanual.io/){.external-link target="_blank"}. Their work is the basis of this tool.
17
17
18
+
## Installation
19
+
20
+
To install the **FastStream CLI**, you need to run the following command:
21
+
22
+
```shell
23
+
pip install faststream[cli]
24
+
```
25
+
26
+
After installation, you can check which commands are available by executing:
0 commit comments