@@ -176,7 +176,7 @@ Pre-commit should be used before pushing a new PR.
176176To use pre-commit, you need to first install the pre-commit package and its dependencies by running:
177177
178178``` bash
179- pip install -r requirements-dev.txt
179+ pip install .
180180```
181181
182182To install pre-commit into your git hooks and run the checks on every commit, run the following each time you clone this
@@ -194,58 +194,26 @@ pre-commit autoupdate && pre-commit run -a
194194
195195## Updating the Python dependencies
196196
197- We are now using pip-compile in order to manage our Python
198- dependencies for the x86_64 and ARM64/AArch64 architectures.
197+ We are using pip-compile in order to manage our Python dependencies.
199198
200- In order to generate requirements.txt files for both architectures,
201- you must use a multi-arch capable virtual machine emulator (like QEMU)
202- and enable multi-arch support.
203-
204- To enable multi-arch support, run the instructions for your container
205- engine and emulator from this table:
206-
207- <table >
208- <tr >
209- <td >Container Engine</td >
210- <td >Emulator</td >
211- <td >Instructions</td >
212- </tr >
213- <tr >
214- <td >podman</td >
215- <td >QEMU</td >
216- <td >
217-
218- ``` bash
219- podman machine ssh
220- sudo rpm-ostree install qemu-user-static
221- sudo systemctl reboot
222- ```
223-
224- </td >
225- </tr >
226- </table >
227-
228- The specification of what packages we need now live in the
229- requirements.in and requirements-dev.in files. Use your preferred
230- editor to make the needed changes in those files, then run
199+ The specification of what packages we need lives in the
200+ ` requirements.in ` file. Use your preferred editor to make the needed
201+ changes in that file, then run:
231202
232203``` bash
233204make pip-compile
234205```
235206
236- This will spin up a container and run the equivalent of these commands
237- to generate the updated files:
207+ This will spin up a container and run the equivalent of:
238208
239209``` bash
240210pip-compile requirements.in
241- pip-compile requirements-dev.in
242211```
243212
244- These commands will produce fully populated and pinned requirements.txt and
245- requirements-dev.txt files, containing all of the dependencies of
246- our dependencies involved. Due to differences in architecture and
247- version of Python between developers' machines, we do not recommend
248- running the pip-compile commands directly.
213+ This command will produce a fully populated and pinned ` requirements.txt `
214+ file, containing all of the dependencies of our dependencies.
215+ Due to differences in architecture and version of Python between
216+ developers' machines, we do not recommend running pip-compile directly.
249217
250218### Use of ` pyproject.toml `
251219
@@ -493,8 +461,7 @@ have backend services (Postgres, Prometheus and Grafana) running.
493461is one handy way for that requirement.
494462
495463For getting the unit test code coverage,
496- install the ` coverage` module, which is included
497- in ` requirements-dev.txt` with the instructions in the
464+ install the ` coverage` module with the instructions in the
498465[Using pre-commit](# using-pre-commit) section.
499466
500467# ## Use make
0 commit comments