Skip to content

Commit f00ad2d

Browse files
authored
chore: README adjustment (#54)
1 parent b6e6411 commit f00ad2d

File tree

1 file changed

+12
-16
lines changed

1 file changed

+12
-16
lines changed

README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,10 @@ To use a specific service, you can install it as:
1717
pip install stackit-redis
1818
```
1919

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.
2921

3022

3123
## 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-
```
3724

3825
In order to install the code from source you have to execute the following code:
3926
```bash
@@ -171,7 +158,11 @@ If you encounter any issues or have suggestions for improvements, please open an
171158
## Contribute
172159

173160
### Installing in editable mode
174-
For development it is best to install in editable mode.
161+
For developing it is recommended to install `poetry`, which can be installed via:
162+
```bash
163+
pip install poetry
164+
165+
For development it is best to install the packages in editable mode.
175166
You can install a single package in editable mode using the following command:
176167
```bash
177168
pip install -e services/<service-name>
@@ -181,7 +172,12 @@ For `redis` the command would be:
181172
```bash
182173
pip install -e services/redis
183174
```
184-
If you want to install all services in editable mode you can use the `Makefile` with the following command:
175+
There are optional dev-dependencies that require `poetry`. Those can be installed with:
176+
```bash
177+
poetry install -C <path-to-the-service> --only dev --no-root
178+
```
179+
180+
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:
185181
```bash
186182
make install-dev
187183
```

0 commit comments

Comments
 (0)