From ab41282fba15a131bafa60efc24381bbf25b629b Mon Sep 17 00:00:00 2001 From: Kevin Froman Date: Fri, 15 Jan 2021 01:53:31 +0000 Subject: [PATCH] Added instructions for generating requirements.txt --- docs/dev/generating-requirements.txt.md | 19 +++++++++++++++++++ docs/dev/setup.md | 6 +++--- 2 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 docs/dev/generating-requirements.txt.md diff --git a/docs/dev/generating-requirements.txt.md b/docs/dev/generating-requirements.txt.md new file mode 100644 index 00000000..75f880b4 --- /dev/null +++ b/docs/dev/generating-requirements.txt.md @@ -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. diff --git a/docs/dev/setup.md b/docs/dev/setup.md index d0794e75..39726f35 100644 --- a/docs/dev/setup.md +++ b/docs/dev/setup.md @@ -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 @@ -30,11 +30,11 @@ Onionr in it's current form is functional, albeit buggy. ## Current major components -Onionr runs via two main HTTP gevent servers serving Flask apps. +Onionr runs via two main HTTP gevent servers serving Flask apps. Dir: apiservers -* 1 Parent app hosts all public API endpoints for the Tor transport. +* 1 Parent app hosts all public API endpoints for the Tor transport. * 1 Parent app hosts all UI-related files and endpoints. Some commands and internal modules interact with this API as well * The HTTP servers have strict anti-dns-rebinding and CSRF countermeasures, so there is a script to craft requests to the UI-related API in scripts/ * Block storage is currently handled via metadata in sqlite (mostly defunct now), and block data storage in a different database. This is in blocks/ in running Onionr daemon data directory