2014-09-04 22:46:34 +02:00
|
|
|
=========================
|
|
|
|
|
Contributing guidelines
|
|
|
|
|
=========================
|
|
|
|
|
|
|
|
|
|
.. include:: ../CONTRIBUTING.rst
|
|
|
|
|
|
|
|
|
|
Setting up the development environment
|
|
|
|
|
--------------------------------------
|
|
|
|
|
|
|
|
|
|
Using a virtualenv_::
|
|
|
|
|
|
|
|
|
|
git clone https://github.com/saimn/sigal.git
|
|
|
|
|
cd sigal
|
|
|
|
|
virtualenv venv
|
2015-06-11 16:06:40 +02:00
|
|
|
. venv/bin/activate
|
2014-09-04 22:46:34 +02:00
|
|
|
|
|
|
|
|
Install sigal in development mode::
|
|
|
|
|
|
|
|
|
|
pip install -e .
|
|
|
|
|
|
|
|
|
|
Install additional dependencies for development (Sphinx, ...)::
|
|
|
|
|
|
|
|
|
|
pip install -r requirements.txt
|
|
|
|
|
|
|
|
|
|
Building the docs
|
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
|
|
- Run ``make docs`` (or ``make html`` in the ``docs/`` directory).
|
|
|
|
|
|
|
|
|
|
Running the test suite
|
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
|
|
- Run ``make test`` (or ``py.test``).
|
|
|
|
|
- Run ``make coverage`` to get the coverage report.
|
|
|
|
|
- Using tox_ you can also run the tests on multiple versions of python.
|
|
|
|
|
|
|
|
|
|
.. _tox: https://testrun.org/tox/
|
|
|
|
|
.. _virtualenv: https://virtualenv.pypa.io/
|
