2016-10-02 10:08:37 +00:00
|
|
|
Development
|
|
|
|
|
===========
|
|
|
|
|
|
|
|
|
|
Help is more than welcome to extend this library. Please see the following resources.
|
|
|
|
|
|
2022-06-04 23:50:09 +00:00
|
|
|
* `Source code repo <https://gitlab.com/jaywink/federation>`_
|
|
|
|
|
* `Issue tracker <https://gitlab.com/jaywink/federation/-/issues>`_
|
2016-10-02 10:08:37 +00:00
|
|
|
|
|
|
|
|
Environment setup
|
|
|
|
|
-----------------
|
|
|
|
|
|
2022-08-19 16:35:12 +00:00
|
|
|
Once you have your (Python 3.7+) virtualenv set up, install the development requirements::
|
2016-10-02 10:08:37 +00:00
|
|
|
|
|
|
|
|
pip install -r dev-requirements.txt
|
|
|
|
|
|
|
|
|
|
Running tests
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
py.test
|
|
|
|
|
|
|
|
|
|
Building local documentation
|
|
|
|
|
----------------------------
|
|
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
cd docs
|
|
|
|
|
make html
|
|
|
|
|
|
2017-07-05 17:08:24 +00:00
|
|
|
Built documentation is available at ``docs/_build/html/index.html``.
|
|
|
|
|
|
2016-10-02 10:08:37 +00:00
|
|
|
Contact for help
|
|
|
|
|
----------------
|
|
|
|
|
|
2022-06-04 23:50:09 +00:00
|
|
|
Easiest via Matrix on room ``#socialhome:federator.dev``.
|
2016-10-02 10:08:37 +00:00
|
|
|
|
|
|
|
|
You can also ask questions or give feedback via issues.
|
