Python中的RAML文档生成器
项目描述
griffin: Python中的RAML参考实现
需求和安装
用户设置
最新版本(目前仅为alpha版本)可以在PyPI上找到,您可以通过pip进行安装
$ pip install griffin --pre
由于它仍在alpha版本中,需要使用--pre来下载。
继续使用,开始使用griffin。
支持的Python/系统
支持Linux和OS X。
开发者设置
如果您想为griffin做出贡献或开发它,请务必先阅读如何贡献。
系统要求
C编译器(gcc/clang等)
如果是在Linux上,您需要安装Python头文件(例如 apt-get install python-dev)
Python 2.6, 2.7, 3.3+或PyPy
以下是设置您的机器的方法
$ git clone git@github.com:spotify/griffin $ cd griffin $ virtualenv env $ source env/bin/activate (env) $ pip install -r dev-requirements.txt
运行测试
如果您想运行所有受支持的Python版本测试,您必须在系统上安装所有Python版本。我建议使用pyenv来帮助您完成此操作。
运行所有测试
(env) $ tox
运行特定的测试设置(选项包括:py26、py27、py33、py34、pypy、flake8、verbose、manifest、docs、setup、setupcov)
(env) $ tox -e py26
在没有tox的情况下运行测试
(env) $ py.test (env) $ py.test --cov griffin --cov-report term-missing
构建文档
文档使用Sphinx构建,使用rST编写,采用Read the Docs主题(略有定制CSS),并托管在Read the Docs站点上。
要在本地重新构建文档,请进入父目录下的griffin目录
(env) $ tox -e docs
或
(env) $ sphinx-build -b docs/ docs/_build
或
(env) $ cd docs (env) $ make html
然后在griffin/docs/_build中,您可以在浏览器中打开index.html页面。
仍有问题吗?
请随时访问Freenode上的#ramlfications(webchat)(尚未设立专用IRC频道)或通过Twitter联系。IRC中的“roguelynn”是维护者,也称为GitHub上的econchick,总部位于旧金山。
变更日志
0.0.1a(2015-07-29)
超级alpha版本!
关闭
griffin-0.0.1.dev1.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 6a75b47caaf32c73ae5e329d6ec6d65fd19029aed403e85e8ae35aba76059a39 |
|
MD5 | 72fed2b2d30d2cbc2ae27dbe426e0412 |
|
BLAKE2b-256 | 25c9ce897a44d47beedbf5d97155e71d46a3c254e04ea08accd083bf54ef4c27 |
关闭
griffin-0.0.1.dev1-py2.py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | c51a3f5fef3c8b5ed97a1106eeed762ec255d52479f9bae460caab5e776ac10d |
|
MD5 | 47b8a8b902c4e80cb594a75282384fdc |
|
BLAKE2b-256 | c9d9d6086c1cc16b232f0b822f28d390504d891537db8c9357d0f67236d2fb20 |