This release is a pre-release and may not be stable for production use.
griffin: RAML reference implementation in Python
Requirements and Installation
User Setup
The latest version (currently alpha only) can be found on PyPI, and you can install via pip:
$ pip install griffin --pre
The --pre is needed to download since it’s still in alpha.
Continue onto usage to get started on using griffin.
Supported Python/Systems
Both Linux and OS X are supported.
Developer Setup
If you’d like to contribute or develop upon griffin, 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
Here’s how to set your machine up:
$ git clone git@github.com:spotify/griffin $ cd griffin $ 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 griffin --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 griffin directory:
(env) $ tox -e docs
or:
(env) $ sphinx-build -b docs/ docs/_build
or:
(env) $ cd docs (env) $ make html
Then within griffin/docs/_build you can open the index.html page in your browser.
Still have issues?
Feel free to drop by #ramlfications on Freenode (webchat) (no dedicated IRC channel - yet) or ping via Twitter. “roguelynn” on IRC is the maintainer, a.k.a econchick on GitHub, and based in San Fran.
Changelog
0.0.1a (2015-07-29)
Super alpha version!
1 maintainer
Release files for griffin 0.0.1.dev1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| griffin-0.0.1.dev1.tar.gz | 1.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| griffin-0.0.1.dev1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 1.1 MB
Release files / griffin-0.0.1.dev1.tar.gz
| Download URL | griffin-0.0.1.dev1.tar.gz |
|---|---|
| Size | 1.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6a75b47caaf32c73ae5e329d6ec6d65fd19029aed403e85e8ae35aba76059a39
|
|
BLAKE2b-256 checksum How to use checksums |
25c9ce897a44d47beedbf5d97155e71d46a3c254e04ea08accd083bf54ef4c27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / griffin-0.0.1.dev1-py2.py3-none-any.whl
| Download URL | griffin-0.0.1.dev1-py2.py3-none-any.whl |
|---|---|
| Size | 14.2 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
c51a3f5fef3c8b5ed97a1106eeed762ec255d52479f9bae460caab5e776ac10d
|
|
BLAKE2b-256 checksum How to use checksums |
c9d9d6086c1cc16b232f0b822f28d390504d891537db8c9357d0f67236d2fb20
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
