.. 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
Note: this project has been discontinued at Spotify and will be transferred to a new maintainer, we are currently finishing the transfer of this repository and the associated pypi package.
The latest stable version can be found on PyPI, and you can install via pip::
$ pip install ramlfications
ramlfications runs on Python 3.10+, and PyPy. Linux , OS X and Windows 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.
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: ^^^^^^^^^^^^^^^^^^^^
apt-get install python-dev)Here's how to set your machine up::
$ git clone git@github.com:jdiegodcp/ramlfications
$ cd ramlfications
$ virtualenv env
$ source env/bin/activate
(env) $ pip install -r dev-requirements.txtRun 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) $ toxTo run a specific test setup (options include: py310, py311, py312, pypy,
flake8, verbose, manifest, docs, setup, setupcov)::
(env) $ tox -e py310To run tests without tox::
(env) $ py.test
(env) $ py.test --cov ramlfications --cov-report term-missingBuild 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 docsor::
(env) $ sphinx-build -b docs/ docs/_buildThen within ramlfications/docs/_build you can open the index.html page in your browser.
Project History ^^^^^^^^^^^^^^^
Ramlfications was originally created by Spotify engineer github.com/econchick, but is currently not in use at Spotify. The project was discontinued in April 2022 and transferred to an external maintainer.
Still have issues? ^^^^^^^^^^^^^^^^^^
Feel free to drop by #ramlfications on Freenode (webchat) or ping via Twitter[X].
"jdiegodcp" is the maintainer, a.k.a jdiegodcp_ on GitHub.
.. _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
.. jdiegodcp: https://github.com/jdiegodcp
.. Twitter[X]: https://twitter.com/jdiegodcp
.. _project management: https://github.com/jdiegodcp/ramlfications/projects/1
.. _plans: https://github.com/spotify/ramlfications/issues/54