Package: ramlfications
ramlfications: RAML reference implementation in PythonNote: 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.Requirements and InstallationUser SetupThe latest stable version can be found onPyPI, and you can install viapip:$ pip install ramlficationsramlficationsruns on Python 3.10+, and PyPy. Linux , OS X and Windows are supported. Currently, only RAML 0.8 is supported, but there areplansto support 1.0.Continue ontousageto get started on usingramlfications.Developer SetupIf you’d like to contribute or develop uponramlfications, be sure to readHow to Contributefirst.You can see the progress oframlficationson our publicproject managementpage.System requirements:C Compiler (gcc/clang/etc.)If on Linux - you’ll need to install Python headers (e.g.apt-getinstallpython-dev)Python 3.10+, or PyPyvirtualenvHere’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 TestsIf you’d like to run tests for all supported Python versions, you must have all Python versions
installed on your system.  I suggestpyenvto 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 DocsDocumentation is build withSphinx, written in rST, uses theRead the Docstheme with
a slightly customized CSS, and is hosted onRead the Docs site.To rebuild docs locally, within the parentramlficationsdirectory:(env) $ tox -e docsor:(env) $ sphinx-build -b docs/ docs/_buildThen withinramlfications/docs/_buildyou can open the index.html page in your browser.Project HistoryRamlfications 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#ramlficationson Freenode (webchat) or ping viaTwitter[X].
“jdiegodcp” is the maintainer, a.k.ajdiegodcpon GitHub.Changelog0.1.9 (2015-12-24)Happy holidays!Fix resource type inheritance (Issue 23&Issue 47)Preserve order ofbaseUriParametersanduriParametersin API root and resource nodes (Issue 37)Fix missing URI parameters if not defined/declared inline (Issue 56)Fix how arguments are passed into pytest insetup.py(PR 55- thank youmatiasb!)0.1.8 (2015-10-07)Fix incorrect/incomplete behavior optional properties of Resource Types (Issue 44).Fixprotocolsinheritance (Issue 44).Partial fix forIssue 23- incorrect resource type inheritanceWhen a resource type is defined with one method that is optional and is applied to a resource that doesnothave that method defined, the resource’s method should not inherit from the optional methodWhen a resource inherits a resource type but explicitly defines named parameters, the named parameters in the resource should overwrite those that are inherited0.1.7 (2015-08-20)Added:Support for parsing$refs in included JSON schemas (Issue 4).  Thank youbenhamill,nvillalva, andjhl2343!Collect all validation errors (rather than just erroring out on the first one) (Issue 21).  Thank youcerivera!0.1.6 (2015-08-03)Added:waffle.iopage to documentation for project management overviewFixed:Parse errors when RAML file would have empty mappings (Issue 30)Switchyaml.Loadertoyaml.SafeLoader(Issue 26)Update documentation to reflect rearrangement of errors (Issue 27)Removedefaultparameter from being required forbaseURIParameters(Issue 29)Pin mock library for tox tests (Issue 22)Experimenting with speeding up pypy tests within tox on Travis0.1.5 (2015-06-05)Fixed:Configuration parsing for validation/production.  Thanksvrajmohan!Parsing of response bodies (fixesIssue 12).  ThanksIgor!0.1.4 (2015-05-27)Added:Support for recursive!includesin RAML files (0.1.3 would handle the error, now actually supports it. ThanksBenfor yourPR!).0.1.3 (2015-05-14)Added:New#ramlficationschannel onfreenode(web chat link)! Come chat, I’m lonely.Documentation for configuration and theupdatecommand.Fixed:Handle recursive/cyclical!includesin RAML files for now (PR)Encoding issues from upgrading to tox 2.0tests/test_utils.pywould createramlfications/data/supported_mime_types.json; now mocked out.0.1.2 (2015-04-21)Fixed:pypy 2.5.x would fail a parser test because order of list was not expected0.1.1 (2015-04-21)New:Added ability to parse IANA-supported MIME media typesAddedupdatecommand for user to update IANA-supported MIME types if/when needed0.1.0a1 (2015-04-18)Initial alpha release oframlfications!