Development#

py-css-styleguide 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.

System requirements#

This will requires Python, pip, virtualenv, GNU make and some other common system packages.

Lists below are the required basic development system packages and some other optional ones.

Warning

Package names may differ depending your system.

  • Git;

  • Python (according version to the package setup);

  • python-dev;

  • make;

Hint

If your system does not have the right Python version as the default one, you should learn to use something like pyenv.

On Linux distribution

You will install them from your common package manager like apt for Debian based distributions:

apt install python-dev make
On macOS

Recommended way is to use brew utility for system packages, some names can vary.

On Windows

Windows is supported but some things may need some tricks on your own.

Deployment#

Once requirements are ready you can use the following commands:

git clone https://github.com/sveetch/py-css-styleguide.git
cd py-css-styleguide
make install

Unittests#

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

make test

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.

Just execute Tox:

make tox

This will run tests for all configured Tox environments, it may takes some time so you may use it only before releasing as a final check.

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

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

Note

You need to build the documentation at least once before using livedocs.

Releasing#

Note

This is only for accredited developers with the rights to release this package to PyPi.

Before releasing, you must ensure about quality, use the command below to run every quality check tasks:

make quality

If quality is correct and after you have correctly pushed all your commits you can proceed to release:

make release

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

Contribution#

  • Every new feature or changed behavior must pass all quality tasks and must be documented (at least docstrings);

  • Every feature or behavior must be compatible for all supported environment;