From 94baa0b3c43954204dd6c2049b36fb7523e6c844 Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Mon, 15 Apr 2019 10:00:20 +0200 Subject: Document developement procedures --- README.rst | 7 ++++--- docs/hacking.rst | 20 ++++++++++++++++++++ 2 files changed, 24 insertions(+), 3 deletions(-) create mode 100644 docs/hacking.rst diff --git a/README.rst b/README.rst index 27af669..4901eeb 100644 --- a/README.rst +++ b/README.rst @@ -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 ` +* `Python3 ` >= 3.7 * `Tornado `_ -* `ruamel.yaml `_ +* `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 -- cgit v1.2.3