Skip to content

Commit b6a250b

Browse files
authored
docs(test-tools): Clarify installation instructions (#80)
* docs(test-tools): Clarify installation instructions * what * improve
1 parent 2ac3408 commit b6a250b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,17 @@ make install-packages opts="--extras 'feature1 feature2'"
4949

5050
#### Installation
5151

52-
1. To make use of the `test_tools` Pytest plugin, install the packages with the `test-tools` extra, e.g. `pip install flagsmith-common[test-tools]`.
52+
1. `poetry add flagsmith-common`
5353

54-
2. Make sure `"common.core"` is in the `INSTALLED_APPS` of your settings module.
54+
2. `poetry add --G dev flagsmith-common[test-tools]` — this will enable the Pytest fixtures. Skipping this step will make Pytest collection fail due to missing dependencies.
55+
56+
3. Make sure `"common.core"` is in the `INSTALLED_APPS` of your settings module.
5557
This enables the `manage.py flagsmith` commands.
5658

57-
3. Add `"common.gunicorn.middleware.RouteLoggerMiddleware"` to `MIDDLEWARE` in your settings module.
59+
4. Add `"common.gunicorn.middleware.RouteLoggerMiddleware"` to `MIDDLEWARE` in your settings module.
5860
This enables the `route` label for Prometheus HTTP metrics.
5961

60-
4. To enable the `/metrics` endpoint, set the `PROMETHEUS_ENABLED` setting to `True`.
62+
5. To enable the `/metrics` endpoint, set the `PROMETHEUS_ENABLED` setting to `True`.
6163

6264
#### Test tools
6365

0 commit comments

Comments
 (0)