diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2019-04-15 10:00:20 +0200 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2019-04-15 10:00:20 +0200 |
| commit | 94baa0b3c43954204dd6c2049b36fb7523e6c844 (patch) | |
| tree | 6c9250f27e35611df5dc9fcac5a8dbd7b8b30edf | |
| parent | 615c439ad45eee9eb709200e3727d1d6eacaecfe (diff) | |
Document developement procedures
| -rw-r--r-- | README.rst | 7 | ||||
| -rw-r--r-- | docs/hacking.rst | 20 |
2 files changed, 24 insertions, 3 deletions
@@ -15,11 +15,12 @@ Dependencies ------------ PyAPD requires the following dependencies and targets their versions as -available in Debian buster. +available in Debian buster. Known minimum versions are listed +explicitely. -* `Python3 <https://www.python.org/>` +* `Python3 <https://www.python.org/>` >= 3.7 * `Tornado <https://www.tornadoweb.org>`_ -* `ruamel.yaml <https://bitbucket.org/ruamel/yaml>`_ +* `ruamel.yaml <https://bitbucket.org/ruamel/yaml>`_ >= 0.15 License ======= diff --git a/docs/hacking.rst b/docs/hacking.rst new file mode 100644 index 0000000..ab51c71 --- /dev/null +++ b/docs/hacking.rst @@ -0,0 +1,20 @@ +######### + Hacking +######### + +The current developement platfor for ``pyapd`` is debian buster with the +following dependencies:: + + apt install python3-tornado python3-ruamel.yaml + +on other platforms you will need to install the same packages in an +appropriate version (see `the README <../README.rst>`_ for details). + +``pyapd`` can be run in place for development: just run +``./pyactivitypubd`` to run a local instance that will listen on +http://localhost:8888 using the configuration in ``pyapd_config.yaml``. + +All tests and QA tools can be run using the script ``./run_tests`` which +requires the following further dependencies:: + + apt install mypy python3-nose2 python3-coverage flake8 |