Development

Development requirements

sveetch-djangoapp-sample is developed with:

  • Test Development Driven (TDD) using Pytest;
  • Respecting flake and pip8 rules using Flake8;
  • Sphinx for documentation with enabled Napoleon extension (using Google style);
  • tox to run tests on various environments;

Every requirements are available in package extra requirements in section dev.

Install for development

First ensure you have pip and virtualenv packages installed then type:

git clone https://github.com/sveetch/sveetch-djangoapp-sample.git
cd sveetch-djangoapp-sample
make install

sveetch-djangoapp-sample will be installed in editable mode from the latest commit on master branch with some development tools.

Unittests

Unittests are made to works on Pytest, a shortcut in Makefile is available to start them on your current development install:

make tests

Tox

To ease development against multiple Python versions a tox configuration has been added. You are strongly encouraged to use it to test your pull requests.

Before using it you will need to install tox, it is recommended to install it at your system level (tox dependancy is not in requirements):

sudo pip install tox

Then go in the sveetch-djangoapp-sample directory execute tox:

tox

Documentation

You can easily build the documentation from one Makefile action:

make docs

There is Makefile action livedocs to serve documentation and automatically rebuild it when you change documentation files:

make livedocs

And go on http://localhost:8002/ or your server machine IP with port 8002.

Note that you need to build the documentation at least once before using livedocs.

Releasing

When you have a release to do, after you have correctly push all your commits you can use the shortcut:

make release

Which will build the package release and send it to Pypi with twine. You may think to configure your Pypi account on your machine to avoid to input it each time.

Contribution

  • Every new feature or changed behavior must pass tests, Flake8 code quality and must be documented.
  • Every feature or behavior must be compatible for all supported environment.