Skip to content
This repository has been archived by the owner on Aug 18, 2023. It is now read-only.

Latest commit

 

History

History
58 lines (38 loc) · 1.76 KB

development.rst

File metadata and controls

58 lines (38 loc) · 1.76 KB
Raw
Development

Development requirement

rstview is developed with:

  • Test Development Driven (TDD) using Pytest;
  • Respecting flake and pip8 rules using Flake8;
  • Sphinx for documentation with enabled Napoleon extension (using only the Google style);
  • tox to test again different Python and Django versions;

Every requirement is available in file dev_requirements.txt (except for tox).

Install for development

First ensure you have pip and virtualenv installed, then in your console terminal type this: :

mkdir rstview-dev
cd rstview-dev
virtualenv --system-site-packages .
source bin/activate
pip install -r https://raw.githubusercontent.com/sveetch/rstview/master/requirements/dev.txt

rstview will be installed in editable mode from the last commit on master branch.

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 again multiple Python and Django 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 so dependancy is not in tests requirements file: :

sudo pip install tox

Then go in the rstview module directory, where the setup.py and tox.ini live and execute tox: :

tox