A Python based policy framework.
Project description
calcifer
========
|Version| |Downloads| |Status| |Coverage| |License|
A Python based policy framework.
Installation
------------
::
pip install calcifer
.. include:: contributing.rst
Development
-----------
1. Create a new virtual environment
2. Install development requirements from *dev-requirements.txt*
3. Run tests ``nosetests``
4. `detox`_ is installed and will run the test suite across all supported python platforms
5. `python setup.py build_sphinx` will generate documentation into *build/sphinx/html*
TL;DR
+++++
::
$ virtualenv env
$ ./env/bin/pip install -qr dev-requirements.txt
$ source env/bin/activate
(env) $ nosetests
(env) $ python setup.py build_sphinx
(env) $ detox
.. include:: ../HISTORY.rst
License
-------
`The Calcifer library is distributed under the MIT License <https://github.com/DramaFever/calcifer/blob/master/LICENSE>`_
.. _detox: https://testrun.org/tox/
.. |Version| image:: https://badge.fury.io/py/calcifer.svg?
:target: http://badge.fury.io/py/calcifer
.. |Status| image:: https://travis-ci.org/DramaFever/calcifer.svg?branch=master
:target: https://travis-ci.org/DramaFever/calcifer
.. |Coverage| image:: https://img.shields.io/coveralls/DramaFever/calcifer.svg?
:target: https://coveralls.io/r/DramaFever/calcifer
.. |Downloads| image:: https://pypip.in/d/calcifer/badge.svg?
:target: https://pypi.python.org/pypi/calcifer
.. |License| image:: https://pypip.in/license/calcifer/badge.svg?
:target: https://calcifer.readthedocs.org
========
|Version| |Downloads| |Status| |Coverage| |License|
A Python based policy framework.
Installation
------------
::
pip install calcifer
.. include:: contributing.rst
Development
-----------
1. Create a new virtual environment
2. Install development requirements from *dev-requirements.txt*
3. Run tests ``nosetests``
4. `detox`_ is installed and will run the test suite across all supported python platforms
5. `python setup.py build_sphinx` will generate documentation into *build/sphinx/html*
TL;DR
+++++
::
$ virtualenv env
$ ./env/bin/pip install -qr dev-requirements.txt
$ source env/bin/activate
(env) $ nosetests
(env) $ python setup.py build_sphinx
(env) $ detox
.. include:: ../HISTORY.rst
License
-------
`The Calcifer library is distributed under the MIT License <https://github.com/DramaFever/calcifer/blob/master/LICENSE>`_
.. _detox: https://testrun.org/tox/
.. |Version| image:: https://badge.fury.io/py/calcifer.svg?
:target: http://badge.fury.io/py/calcifer
.. |Status| image:: https://travis-ci.org/DramaFever/calcifer.svg?branch=master
:target: https://travis-ci.org/DramaFever/calcifer
.. |Coverage| image:: https://img.shields.io/coveralls/DramaFever/calcifer.svg?
:target: https://coveralls.io/r/DramaFever/calcifer
.. |Downloads| image:: https://pypip.in/d/calcifer/badge.svg?
:target: https://pypi.python.org/pypi/calcifer
.. |License| image:: https://pypip.in/license/calcifer/badge.svg?
:target: https://calcifer.readthedocs.org
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
calcifer-0.0.0.tar.gz
(26.8 kB
view hashes)
Built Distribution
Close
Hashes for calcifer-0.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e441e5c0391c82c39118881aa7894b8f9f623592546dcec125c9e27ef446e90 |
|
MD5 | 42e37b44b47defed66edcded07bf719b |
|
BLAKE2b-256 | b7f0f47b138ab0ffd07bb8319e3d6227b7f441c72fbf6758d891dee724644854 |