@@ -88,85 +88,6 @@ handle_message(
8888
8989
9090
91- # # Contribute
92-
93- # ## Setup package for development
94-
95- - Create a Python virtualenv and activate it
96- - Install " pip-tools" with `pip install - U pip- tools`
97- - Compile the requirements with `pip- compile -- extra dev, - o requirements.txt pyproject.toml -- resolver=backtracking`
98- - Sync the dependencies with your virtualenv with `pip- sync`
99-
100- # ## Add functionality
101-
102- - Create a new branch for your feature
103- - Change the dependency in your requirements.txt to a local (editable) one that points to your local file system:
104- `- e / Users/ workspace/ django- queuebie` or via pip `pip install - e / Users/ workspace/ django- queuebie`
105- - Ensure the code passes the tests
106- - Create a pull request
107-
108- # ## Run tests
109-
110- - Run tests
111- ````
112- pytest -- ds settings tests
113- ````
114-
115- - Check coverage
116- ````
117- coverage run - m pytest -- ds settings tests
118- coverage report - m
119- ````
120-
121- # ## Git hooks (via pre-commit)
122-
123- We use pre- push hooks to ensure that only linted code reaches our remote repository and pipelines aren' t triggered in
124- vain.
125-
126- To enable the configured pre- push hooks, you need to [install](https:// pre- commit.com/ ) pre- commit and run once:
127-
128- pre- commit install - t pre- push - t pre- commit -- install- hooks
129-
130- This will permanently install the git hooks for both, frontend and backend, in your local
131- [`.git/ hooks` ](./ .git/ hooks) folder.
132- The hooks are configured in the [`.pre- commit- config.yaml` ](templates/ .pre- commit- config.yaml.tpl).
133-
134- You can check whether hooks work as intended using the [run](https:// pre- commit.com/ # pre-commit-run) command:
135-
136- pre- commit run [hook- id ] [options]
137-
138- Example: run single hook
139-
140- pre- commit run ruff -- all - files
141-
142- Example: run all hooks of pre- push stage
143-
144- pre- commit run -- all - files -- hook- stage push
145-
146- # ## Update documentation
147-
148- - To build the documentation, run: `sphinx- build docs/ docs/ _build/ html/ ` .
149- - Open `docs/ _build/ html/ index.html` to see the documentation.
150-
151-
152- # ## Translation files
153-
154- If you have added custom text, make sure to wrap it in `_()` where `_` is
155- gettext_lazy (`from django.utils.translation import gettext_lazy as _` ).
156-
157- How to create translation file :
158-
159- * Navigate to `django- queuebie`
160- * `python manage.py makemessages - l de`
161- * Have a look at the new/ changed files within `queuebie/ locale`
162-
163- How to compile translation files:
164-
165- * Navigate to `django- queuebie`
166- * `python manage.py compilemessages`
167- * Have a look at the new/ changed files within `queuebie/ locale`
168-
169-
17091# ## Publish to ReadTheDocs.io
17192
17293- Fetch the latest changes in GitHub mirror and push them
@@ -203,4 +124,3 @@ configuration and setup files. It works similar to well-known updaters like `pyu
203124
204125To run an update, refer to the [documentation page](https://pypi.org/project/ambient-package-update/)
205126of the "ambient-package-update".
206-
0 commit comments