gvacommon/README.rst

=========
gvacommon
=========

This module contains code that is intended to be shared between gnuviechadmin
components.

Install dependencies
====================

.. code-block::

   pipenv install --dev

Run tests
=========

To run the unit tests and report test coverage use:

.. code-block::

   pipenv run coverage run --branch setup.py test
   pipenv run coverage report -m
Port to Python 3, use pipenv, add defaults to get_env_variable 2018-11-17 13:31:16 +01:00			`=========`
Make gvacommon distributable This commit performs a lot of changes to make gvacommon properly distributable: - add a setup.py - move code into a module directory - add a __version__ - add a README.rst and AGPLv3 license file (COPYING) - specify the licensing in file headers - move tests into a submodule of gvacommon and split tests for different modules into separate test modules - get rid of django-braces dependency - adapt setup.cfg to the new directory structure - ignore build and dist directories 2016-01-29 13:40:12 +01:00			`gvacommon`
			`=========`

			`This module contains code that is intended to be shared between gnuviechadmin`
			`components.`
Port to Python 3, use pipenv, add defaults to get_env_variable 2018-11-17 13:31:16 +01:00
			`Install dependencies`
			`====================`

			`.. code-block::`

			`pipenv install --dev`

			`Run tests`
			`=========`

Add instructions how to report test coverage 2020-03-02 11:18:52 +01:00			`To run the unit tests and report test coverage use:`

Port to Python 3, use pipenv, add defaults to get_env_variable 2018-11-17 13:31:16 +01:00			`.. code-block::`

Add instructions how to report test coverage 2020-03-02 11:18:52 +01:00			`pipenv run coverage run --branch setup.py test`
			`pipenv run coverage report -m`