ramlfications: RAML reference implementation in Python

.. image:: https://img.shields.io/travis/spotify/ramlfications.svg?style=flat-square :target: https://travis-ci.org/spotify/ramlfications :alt: CI status

.. image:: https://img.shields.io/pypi/v/ramlfications.svg?style=flat-square :target: https://pypi.python.org/pypi/ramlfications/ :alt: Latest Version

.. image:: https://img.shields.io/pypi/status/ramlfications.svg?style=flat-square :target: https://pypi.python.org/pypi/ramlfications/ :alt: Development Status

.. image:: https://img.shields.io/pypi/l/ramlfications.svg?style=flat-square :target: https://github.com/spotify/ramlfications/blob/master/LICENSE :alt: License

.. image:: https://codecov.io/github/spotify/ramlfications/coverage.svg?branch=master :target: https://codecov.io/github/spotify/ramlfications?branch=master :alt: Current coverage

.. image:: https://img.shields.io/pypi/pyversions/ramlfications.svg?style=flat-square :target: https://pypi.python.org/pypi/ramlfications/ :alt: Supported Python versions

.. begin

Requirements and Installation

User Setup

The latest stable version can be found on PyPI_, and you can install via pip_::

$ pip install ramlfications

ramlfications runs on Python 2.6, 2.7, and 3.3+, and PyPy. Both Linux and OS X are supported. Currently, only RAML 0.8 is supported, but there are plans_ to support 1.0.

Continue onto usage_ to get started on using ramlfications.

Developer Setup

If you'd like to contribute or develop upon ramlfications, be sure to read How to Contribute_ first.

You can see the progress of ramlfications on our public project management_ page.

System requirements: ^^^^^^^^^^^^^^^^^^^^

• C Compiler (gcc/clang/etc.)
• If on Linux - you'll need to install Python headers (e.g. apt-get install python-dev)
• Python 2.6, 2.7, 3.3+, or PyPy
• virtualenv_

Here's how to set your machine up::

$ git clone [email protected]:spotify/ramlfications
$ cd ramlfications
$ virtualenv env
$ source env/bin/activate
(env) $ pip install -r dev-requirements.txt

Run Tests ^^^^^^^^^

If you'd like to run tests for all supported Python versions, you must have all Python versions installed on your system. I suggest pyenv_ to help with that.

To run all tests::

(env) $ tox

To run a specific test setup (options include: py26, py27, py33, py34, py35, pypy, flake8, verbose, manifest, docs, setup, setupcov)::

(env) $ tox -e py26

To run tests without tox::

(env) $ py.test
(env) $ py.test --cov ramlfications --cov-report term-missing

Build Docs ^^^^^^^^^^

Documentation is build with Sphinx_, written in rST, uses the Read the Docs_ theme with a slightly customized CSS, and is hosted on Read the Docs site_.

To rebuild docs locally, within the parent ramlfications directory::

(env) $ tox -e docs

or::

(env) $ sphinx-build -b docs/ docs/_build

Then within ramlfications/docs/_build you can open the index.html page in your browser.

Still have issues? ^^^^^^^^^^^^^^^^^^

Feel free to drop by #ramlfications on Freenode (webchat) or ping via Twitter. "roguelynn" is the maintainer, a.k.a econchick_ on GitHub, and based in San Fran.

.. _pip: https://pip.pypa.io/en/latest/installing.html#install-pip .. _PyPI: https://pypi.python.org/project/ramlfications/ .. _virtualenv: https://virtualenv.pypa.io/en/latest/ .. _pyenv: https://github.com/yyuu/pyenv .. _Sphinx: http://sphinx-doc.org/ .. _Read the Docs: https://github.com/snide/sphinx_rtd_theme .. _Read the Docs site: https://ramlfications.readthedocs.io .. _usage: https://ramlfications.readthedocs.io/en/latest/usage.html .. _How to Contribute: https://ramlfications.readthedocs.io/en/latest/contributing.html .. _webchat: http://webchat.freenode.net?channels=%23ramlfications&uio=ND10cnVlJjk9dHJ1ZQb4 .. _econchick: https://github.com/econchick .. _Twitter: https://twitter.com/roguelynn .. _project management: https://waffle.io/spotify/ramlfications .. _plans: https://github.com/spotify/ramlfications/issues/54