Initial development requirements: pip-tools
This commit is contained in:
parent
dbc445e0eb
commit
aca92e6a04
|
@ -0,0 +1,21 @@
|
||||||
|
## Development Environment FAQ
|
||||||
|
|
||||||
|
### How to maintain `requirements.txt`?
|
||||||
|
|
||||||
|
The canonical list of installation requirements (including development requirements) is maintained in the [`setup.py`](setup.py) file.
|
||||||
|
|
||||||
|
The Requirements File ([`requirements.txt`](requirements.txt)) file must be kept in sync with that list.
|
||||||
|
|
||||||
|
To to automatically generate or update `requirements.txt` based on `setup.py`, run [`pip-tools`](https://github.com/jazzband/pip-tools)’s `pip-compile`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python -m piptools compile --output-file=requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
**Warning:** Due to [limitations](https://github.com/jazzband/pip-tools/issues/908) in `pip-tools`, the same workflow can not be used for generating a `dev-requirements.txt` file, and requirements can not be declared in a `setup.cfg` file.
|
||||||
|
|
||||||
|
### How to install modules required for development?
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python -m pip install -e ".[dev]"
|
||||||
|
```
|
5
setup.py
5
setup.py
|
@ -4,6 +4,10 @@ requirements = [
|
||||||
"django",
|
"django",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
dev_requirements = [
|
||||||
|
"pip-tools",
|
||||||
|
]
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="ungleich_screening_task",
|
name="ungleich_screening_task",
|
||||||
version="0.1.0",
|
version="0.1.0",
|
||||||
|
@ -12,4 +16,5 @@ setup(
|
||||||
author_email="eric.redon@coox.org",
|
author_email="eric.redon@coox.org",
|
||||||
python_requires=">=3.6",
|
python_requires=">=3.6",
|
||||||
install_requires=requirements,
|
install_requires=requirements,
|
||||||
|
extras_require={"dev": dev_requirements},
|
||||||
)
|
)
|
||||||
|
|
Loading…
Reference in New Issue