Skip to content

Commit

Permalink
Add first itteration of project details in rst
Browse files Browse the repository at this point in the history
  • Loading branch information
@Grokzen
Grokzen committed Jan 22, 2017
1 parent 7bdb542 commit 8c434de
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,74 @@ If this do not work please open up a issue with your schema and data that can be
Project details
---------------

.. |travis-master| image:: https://travis-ci.org/Grokzen/pykwalify.svg?branch=master
:target: https://travis-ci.org/Grokzen/pykwalify

.. |travis-unstable| image:: https://travis-ci.org/Grokzen/pykwalify.svg?branch=unstable
:target: https://travis-ci.org/Grokzen/pykwalify

.. |gitter-badge| image:: https://badges.gitter.im/Join Chat.svg
:target: https://gitter.im/Grokzen/pykwalify?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

.. |coveralls-badge| image:: https://coveralls.io/repos/github/Grokzen/pykwalify/badge.svg?branch=unstable
:target: https://coveralls.io/github/Grokzen/pykwalify?branch=unstable

+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| python support | 2.7, 3.3, 3.4, 3.5, 3.6, 3.7 |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Source | https://github.com/Grokzen/pykwalify |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Docs (Latest release) | http://pykwalify.readthedocs.io/en/master/ |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Docs (Unstable branch)| http://pykwalify.readthedocs.io/en/unstable/ |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Gitter (Free Chat) | |gitter-badge| |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Changelog | https://github.com/Grokzen/pykwalify/blob/unstable/docs/release-notes.rst |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Upgrade instructions | https://github.com/Grokzen/pykwalify/blob/unstable/docs/upgrade-instructions.rst |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Issues | https://github.com/Grokzen/pykwalify/issues |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Travis (master) | |travis-master| |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Travis (unstable) | |travis-unstable| |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Test coverage | |coveralls-badge| |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| pypi | https://pypi.python.org/pypi/pykwalify/ |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Open Hub | https://www.openhub.net/p/pykwalify |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| License | MIT https://github.com/Grokzen/pykwalify/blob/unstable/docs/license.rst |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Copyright | Copyright (c) 2013-2017 Johan Andersson |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| git repo | git clone git@github.com:Grokzen/pykwalify.git |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| install stable | pip install pykwalify |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| install dev | .. code-block:: bash |
| | |
| | $ git clone git@github.com:Grokzen/pykwalify.git pykwalify |
| | $ cd ./pykwalify |
| | $ virtualenv .venv |
| | $ source .venv/bin/activate |
| | $ pip install -r dev-requirements.txt |
| | $ pip install -e . |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| required dependencies | docopt >= 0.6.2 |
| | python-dateutil >= 2.4.2 |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| supported yml parsers | PyYaml >= 3.11 |
| | ruamel.yaml >= 0.11.0 |
+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+



The Usage Guide
---------------

Expand Down

0 comments on commit 8c434de

Please sign in to comment.