@@ -17,23 +17,10 @@ To use a specific service, you can install it as:
17
17
pip install stackit-redis
18
18
```
19
19
20
- It will pull all needed dependencies automatically, so you can use the package right away.
21
-
22
- To use all services, you can install the whole SDK with a single package:
23
-
24
- ``` bash
25
- pip install stackit
26
- ```
27
-
28
- This allows you to use any services that the SDK offers.
20
+ It will install all needed dependencies automatically, so you can use the package right away.
29
21
30
22
31
23
## Installation from source
32
- For an installation from source ` poetry ` is required.
33
- It can be installed with the following command:
34
- ``` bash
35
- pip install poetry
36
- ```
37
24
38
25
In order to install the code from source you have to execute the following code:
39
26
``` bash
@@ -171,7 +158,13 @@ If you encounter any issues or have suggestions for improvements, please open an
171
158
## Contribute
172
159
173
160
### Installing in editable mode
174
- For development it is best to install in editable mode.
161
+ For developing is is recommended to install `poetry`.
162
+ It can be installed with:
163
+ ```bash
164
+ pip install poetry
165
+ ```
166
+
167
+ For development it is best to install the packages in editable mode.
175
168
You can install a single package in editable mode using the following command:
176
169
``` bash
177
170
pip install -e services/< service-name>
@@ -181,7 +174,12 @@ For `redis` the command would be:
181
174
``` bash
182
175
pip install -e services/redis
183
176
```
184
- If you want to install all services in editable mode you can use the ` Makefile ` with the following command:
177
+ There are optional dev-dependencies that require ` poetry ` . Those can be installed with:
178
+ ``` bash
179
+ poetry install -C < path-to-the-service> --only dev --no-root
180
+ ```
181
+
182
+ If you want to install all services in editable mode, as well as the dev-dependencies, you can use the ` Makefile ` with the following command:
185
183
``` bash
186
184
make install-dev
187
185
```
0 commit comments