.. 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.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: py310, py311, py312, pypy,
flake8, verbose, manifest, docs, setup, setupcov)::
(env) $ tox -e py310
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.
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
Happy holidays!
Issue 23_ & Issue 47_)baseUriParameters and uriParameters in API root and resource nodes (Issue 37_)Issue 56_)setup.py (PR 55_ - thank you matiasb_!)Fix incorrect/incomplete behavior optional properties of Resource Types (Issue 44_).
Fix protocols inheritance (Issue 44_).
Partial fix for Issue 23_ - incorrect resource type inheritance
Added:
$ref s in included JSON schemas (Issue 4). Thank you benhamill, nvillalva, and jhl2343!Issue 21). Thank you cerivera!Added:
waffle.io_ page to documentation for project management overviewFixed:
Issue 30_)yaml.Loader to yaml.SafeLoader (Issue 26_)Issue 27_)default parameter from being required for baseURIParameters (Issue 29_)Issue 22_)Fixed:
vrajmohan_!Issue 12). Thanks Igor!Added:
!includes in RAML files (0.1.3 would handle the error, now actually supports it. Thanks Ben_ for your PR_!).Added:
#ramlfications channel on freenode_ (web chat link)! Come chat, I'm lonely.update command.Fixed:
!includes in RAML files for now (PR_)tests/test_utils.py would create ramlfications/data/supported_mime_types.json; now mocked out.Fixed:
New:
update command for user to update IANA-supported MIME types if/when neededInitial alpha release of ramlfications!
.. _PR: https://github.com/spotify/ramlfications/pull/8
.. _freenode: http://webchat.freenode.net?channels=%23ramlfications&uio=ND10cnVlJjk9dHJ1ZQb4
.. _Ben: https://github.com/benhamill
.. _vrajmohan: https://github.com/spotify/ramlfications/pull/16
.. _Issue 12: https://github.com/spotify/ramlfications/issues/12
.. _Igor: https://github.com/spotify/ramlfications/pull/13
.. _Issue 30: https://github.com/spotify/ramlfications/issues/30
.. _Issue 26: https://github.com/spotify/ramlfications/issues/26
.. _Issue 27: https://github.com/spotify/ramlfications/issues/27
.. _Issue 29: https://github.com/spotify/ramlfications/issues/29
.. _Issue 22: https://github.com/spotify/ramlfications/issues/22
.. _waffle.io: https://waffle.io/spotify/ramlfications
.. _Issue 4: https://github.com/spotify/ramlfications/issues/4
.. _benhamill: https://github.com/benhamill
.. _nvillalva: https://github.com/nvillalva
.. _jhl2343: https://github.com/jhl2343
.. _Issue 21: https://github.com/spotify/ramlfications/issues/21
.. _cerivera: https://github.com/cerivera
.. _Issue 44: https://github.com/spotify/ramlfications/issues/44
.. _Issue 23: https://github.com/spotify/ramlfications/issues/23
.. _matiasb: https://github.com/matiasb
.. _PR 55: https://github.com/spotify/ramlfications/pull/55
.. _Issue 47: https://github.com/spotify/ramlfications/issues/47
.. _Issue 37: https://github.com/spotify/ramlfications/issues/37
.. _Issue 56: https://github.com/spotify/ramlfications/issues/56
FAQs
A Python RAML parser
We found that ramlfications demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.