Metadata-Version: 2.0
Name: ramlfications
Version: 0.1.2
Summary: A Python RAML parser
Home-page: https://ramlfications.readthedocs.org
Author: Lynn Root
Author-email: lynn@spotify.com
License: Apache 2.0
Keywords: raml,rest
Platform: UNKNOWN
Classifier: Development Status :: 4 – Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: Apache License 2.0
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: attrs
Requires-Dist: click
Requires-Dist: markdown2
Requires-Dist: pyyaml
Requires-Dist: six
Requires-Dist: termcolor
Requires-Dist: xmltodict

ramlfications: RAML reference implementation in Python
======================================================

.. image:: https://pypip.in/version/ramlfications/badge.svg
   :target: https://pypi.python.org/pypi/ramlfications/
   :alt: Latest Version

.. image:: https://travis-ci.org/spotify/ramlfications.png?branch=master
   :target: https://travis-ci.org/spotify/ramlfications
   :alt: CI status

.. image:: https://coveralls.io/repos/spotify/ramlfications/badge.svg?branch=master
   :target: https://coveralls.io/r/spotify/ramlfications?branch=master
   :alt: Current coverage

.. image:: https://readthedocs.org/projects/ramlfications/badge/?version=latest
   :target: https://ramlfications.readthedocs.org/en/latest/
   :alt: Documentation Status

.. image:: https://pypip.in/py_versions/ramlfications/badge.svg
    :target: https://pypi.python.org/pypi/ramlfications/
    :alt: Supported Python versions

.. image:: https://pypip.in/implementation/ramlfications/badge.svg
    :target: https://pypi.python.org/pypi/ramlfications/
    :alt: Supported Python implementations

.. image:: https://pypip.in/status/ramlfications/badge.svg
    :target: https://pypi.python.org/pypi/ramlfications/
    :alt: Development Status

.. 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.

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.

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 git@github.com: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``, ``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.



.. _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.org
.. _`usage`: http://ramlfications.readthedocs.org/en/latest/usage.html
.. _`How to Contribute`: http://ramlfications.readthedocs.org/en/latest/contributing.html

Changelog
=========

0.1.2 (2015-04-21)
------------------

Fixed:

- pypy 2.5.x would fail a parser test because order of list was not expected

0.1.1 (2015-04-21)
------------------

New:

- Added ability to parse IANA-supported MIME media types
- Added ``update`` command for user to update IANA-supported MIME types if/when needed

0.1.0a1 (2015-04-18)
--------------------
Initial alpha release of ``ramlfications``\!


