aboutsummaryrefslogtreecommitdiff
path: root/docs/hacking.rst
blob: ab51c71fe24b1f8a7dfb70687f1641955928c4b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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