{ "info": { "author": "Lynn Root", "author_email": "lynn@spotify.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Documentation", "Topic :: Software Development :: Documentation", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "griffin: RAML reference implementation in Python\n======================================================\n\n.. image:: https://img.shields.io/pypi/v/griffin.svg?style=flat-square\n :target: https://pypi.python.org/pypi/griffin/\n :alt: Latest Version\n\n.. image:: https://img.shields.io/travis/spotify/griffin.svg?style=flat-square\n :target: https://travis-ci.org/spotify/griffin\n :alt: CI status\n\n.. image:: https://img.shields.io/pypi/status/griffin.svg?style=flat-square\n :target: https://pypi.python.org/pypi/griffin/\n :alt: Development Status\n\n.. image:: https://img.shields.io/pypi/l/griffin.svg?style=flat-square\n :target: https://github.com/spotify/griffin/blob/master/LICENSE\n :alt: License\n\n.. image:: https://img.shields.io/coveralls/spotify/griffin/master.svg?style=flat-square\n :target: https://coveralls.io/r/spotify/griffin?branch=master\n :alt: Current coverage\n\n.. image:: https://img.shields.io/pypi/pyversions/griffin.svg?style=flat-square\n :target: https://pypi.python.org/pypi/griffin/\n :alt: Supported Python versions\n\n.. begin\n\n.. warning::\n\n This is an ALPHA! Be prepared for shit to break!\n\nRequirements and Installation\n=============================\n\nUser Setup\n----------\n\nThe latest version (currently alpha only) can be found on PyPI_, and you can install via pip_::\n\n $ pip install griffin --pre\n\nThe ``--pre`` is needed to download since it's still in alpha.\n\nContinue onto `usage`_ to get started on using ``griffin``.\n\nSupported Python/Systems\n^^^^^^^^^^^^^^^^^^^^^^^^\n\n.. warning::\n currently runs with Python 2.7 - but will get up to 3.3+ and PyPy\n\nBoth Linux and OS X are supported.\n\n\n\nDeveloper Setup\n---------------\n\nIf you'd like to contribute or develop upon ``griffin``, be sure to read `How to Contribute`_\nfirst.\n\nSystem requirements:\n^^^^^^^^^^^^^^^^^^^^\n\n- C Compiler (gcc/clang/etc.)\n- If on Linux - you'll need to install Python headers (e.g. ``apt-get install python-dev``)\n- Python 2.6, 2.7, 3.3+, or PyPy\n- virtualenv_\n\nHere's how to set your machine up::\n\n $ git clone git@github.com:spotify/griffin\n $ cd griffin\n $ virtualenv env\n $ source env/bin/activate\n (env) $ pip install -r dev-requirements.txt\n\n\nRun Tests\n^^^^^^^^^\n\nIf you'd like to run tests for all supported Python versions, you must have all Python versions\ninstalled on your system. I suggest pyenv_ to help with that.\n\nTo run all tests::\n\n (env) $ tox\n\nTo run a specific test setup (options include: ``py26``, ``py27``, ``py33``, ``py34``, ``pypy``,\n``flake8``, ``verbose``, ``manifest``, ``docs``, ``setup``, ``setupcov``)::\n\n (env) $ tox -e py26\n\nTo run tests without tox::\n\n (env) $ py.test\n (env) $ py.test --cov griffin --cov-report term-missing\n\n\nBuild Docs\n^^^^^^^^^^\n\nDocumentation is build with Sphinx_, written in rST, uses the `Read the Docs`_ theme with\na slightly customized CSS, and is hosted on `Read the Docs site`_.\n\nTo rebuild docs locally, within the parent ``griffin`` directory::\n\n (env) $ tox -e docs\n\nor::\n\n (env) $ sphinx-build -b docs/ docs/_build\n\n\nor::\n\n (env) $ cd docs\n (env) $ make html\n\nThen within ``griffin/docs/_build`` you can open the index.html page in your browser.\n\n\nStill have issues?\n^^^^^^^^^^^^^^^^^^\n\nFeel free to drop by ``#ramlfications`` on Freenode (`webchat`_) (no dedicated IRC channel - yet) \\\nor ping via `Twitter`_. \"roguelynn\" on IRC is the maintainer, a.k.a `econchick`_ on GitHub, \\\nand based in San Fran.\n\n\n.. _pip: https://pip.pypa.io/en/latest/installing.html#install-pip\n.. _PyPI: https://pypi.python.org/project/griffin/\n.. _virtualenv: https://virtualenv.pypa.io/en/latest/\n.. _pyenv: https://github.com/yyuu/pyenv\n.. _Sphinx: http://sphinx-doc.org/\n.. _`Read the Docs`: https://github.com/snide/sphinx_rtd_theme\n.. _`Read the Docs site`: https://griffin.readthedocs.org\n.. _`usage`: http://griffin.readthedocs.org/en/latest/usage.html\n.. _`How to Contribute`: http://griffin.readthedocs.org/en/latest/contributing.html\n.. _`webchat`: http://webchat.freenode.net?channels=%23ramlfications&uio=ND10cnVlJjk9dHJ1ZQb4\n.. _`econchick`: https://github.com/econchick\n.. _`Twitter`: https://twitter.com/roguelynn\n\nChangelog\n=========\n\n0.0.1a (2015-07-29)\n-------------------\n\nSuper alpha version!", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://griffin.readthedocs.org", "keywords": "raml,rest", "license": "Apache 2.0", "maintainer": null, "maintainer_email": null, "name": "griffin", "package_url": "https://pypi.org/project/griffin/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/griffin/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://griffin.readthedocs.org" }, "release_url": "https://pypi.org/project/griffin/0.0.1.dev1/", "requires_dist": null, "requires_python": null, "summary": "A RAML documentation generator in Python", "version": "0.0.1.dev1" }, "last_serial": 1666214, "releases": { "0.0.1.dev1": [ { "comment_text": "", "digests": { "md5": "47b8a8b902c4e80cb594a75282384fdc", "sha256": "c51a3f5fef3c8b5ed97a1106eeed762ec255d52479f9bae460caab5e776ac10d" }, "downloads": -1, "filename": "griffin-0.0.1.dev1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "47b8a8b902c4e80cb594a75282384fdc", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 14212, "upload_time": "2015-08-05T23:52:13", "url": "https://files.pythonhosted.org/packages/c9/d9/d6086c1cc16b232f0b822f28d390504d891537db8c9357d0f67236d2fb20/griffin-0.0.1.dev1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "72fed2b2d30d2cbc2ae27dbe426e0412", "sha256": "6a75b47caaf32c73ae5e329d6ec6d65fd19029aed403e85e8ae35aba76059a39" }, "downloads": -1, "filename": "griffin-0.0.1.dev1.tar.gz", "has_sig": false, "md5_digest": "72fed2b2d30d2cbc2ae27dbe426e0412", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1091662, "upload_time": "2015-08-05T23:52:26", "url": "https://files.pythonhosted.org/packages/25/c9/ce897a44d47beedbf5d97155e71d46a3c254e04ea08accd083bf54ef4c27/griffin-0.0.1.dev1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "47b8a8b902c4e80cb594a75282384fdc", "sha256": "c51a3f5fef3c8b5ed97a1106eeed762ec255d52479f9bae460caab5e776ac10d" }, "downloads": -1, "filename": "griffin-0.0.1.dev1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "47b8a8b902c4e80cb594a75282384fdc", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 14212, "upload_time": "2015-08-05T23:52:13", "url": "https://files.pythonhosted.org/packages/c9/d9/d6086c1cc16b232f0b822f28d390504d891537db8c9357d0f67236d2fb20/griffin-0.0.1.dev1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "72fed2b2d30d2cbc2ae27dbe426e0412", "sha256": "6a75b47caaf32c73ae5e329d6ec6d65fd19029aed403e85e8ae35aba76059a39" }, "downloads": -1, "filename": "griffin-0.0.1.dev1.tar.gz", "has_sig": false, "md5_digest": "72fed2b2d30d2cbc2ae27dbe426e0412", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1091662, "upload_time": "2015-08-05T23:52:26", "url": "https://files.pythonhosted.org/packages/25/c9/ce897a44d47beedbf5d97155e71d46a3c254e04ea08accd083bf54ef4c27/griffin-0.0.1.dev1.tar.gz" } ] }