Added instructions for generating requirements.txt
This commit is contained in:
parent
fd440b8b91
commit
54f6e3bdc6
19
docs/dev/generating-requirements.txt.md
Normal file
19
docs/dev/generating-requirements.txt.md
Normal file
@ -0,0 +1,19 @@
|
||||
# Generating requirements.txt
|
||||
|
||||
To generate a requirements.txt file, install pip-tools from pip
|
||||
|
||||
Onionr requirements files should have hashes to prevent backdooring by the pypi server.
|
||||
|
||||
Put your package versions in requirements.in like normal. Child dependencies are usually not necessary:
|
||||
|
||||
```
|
||||
requests==0.1.1
|
||||
flask==0.1.1
|
||||
```
|
||||
|
||||
Then generate the requirements.txt:
|
||||
|
||||
`$ pip-compile requirements.in --generate-hashes -o requirements.txt`
|
||||
|
||||
|
||||
Your requirements.txt will have hash-pinned requirements of all dependencies and child dependencies.
|
@ -6,7 +6,7 @@ The Onionr development environment is simple. All one really needs is a supporte
|
||||
|
||||
There are additional requirements specified in requirements-dev.txt
|
||||
|
||||
Developers agree to the CoC and to contribute new code under GPLv3 or later. Developers should stick to PEP8 in most cases, and write unittests or integration tests where possible.
|
||||
**Developers agree to the [CoC](../../CODE_OF_CONDUCT.md) and to contribute new code under GPLv3 or later**. Developers should stick to PEP8 in most cases, and write unittests or integration tests where possible.
|
||||
|
||||
## Developer Scripts
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user