Warning
This is an ALPHA! Be prepared for shit to break!
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.
Griffin runs on Python 2.6, 2.7, 3.3+ and pypy. Both Linux and OS X are supported.
If you'd like to contribute or develop upon griffin, be sure to read How to Contribute
first.
- 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
- virtualenv
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
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
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.
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.