python中的raml文档生成器

griffin的Python项目详细描述


griffin:raml在python中的引用实现

Latest VersionCI statusDevelopment StatusLicenseCurrent coverageSupported Python versions

警告

这是阿尔法!准备好让狗屎破了!

要求和安装

用户设置

最新版本(当前仅限alpha)可以在PyPI上找到,您可以通过pip

$ pip install griffin --pre

需要下载--pre,因为它仍在alpha中。

继续usage开始使用griffin

支持的python/系统

警告

当前使用Python2.7运行,但将获得3.3+和PyPy

Linux和OS X都受支持。

开发者设置

如果你想在griffin上贡献或发展,请务必阅读How to Contribute 第一。

系统要求:

  • C编译器(gcc/clang/etc.)
  • 如果在linux上,您需要安装python头文件(例如apt-get install python-dev
  • python 2.6、2.7、3.3+或pypy
  • virtualenv

以下是如何设置您的机器:

$ 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

运行特定的测试设置(选项包括:py26py27py33py34pypy, ^{TT10}$,^{TT11}$,^{TT12}$,^{TT13}$,^{TT14}$,^{TT15}$):

(env) $ tox -e py26

运行不含毒素的测试:

(env) $ py.test
(env) $ py.test --cov griffin --cov-report term-missing

生成文档

文档是用Sphinx构建的,用rst编写,使用Read the Docs主题 一个稍微定制的css,托管在Read the Docs site

要在本地重建文档,请在父目录griffin中:

(env) $ tox -e docs

或:

(env) $ sphinx-build -b docs/ docs/_build

或:

(env) $ cd docs
(env) $ make html

然后在griffin/docs/_build中,您可以在浏览器中打开index.html页面。

还有问题吗?

请随意访问#ramlfications到freenode(webchat)(还没有专用的irc通道)或通过Twitterping。irc上的“roguelynn”是维护者,也就是github上的econchick,位于旧金山。

更改日志

0.0.1a(2015-07-29)

超级阿尔法版本!

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java未从Facebook OAuth接收名字、姓氏和姓氏   我自己代码中的java ConcurrentModificationException   java在Android上获得单像素TIFF图像   java图形输出中的swing集成弹出窗口“通知”   将数据库表中的所有数据集插入jTable Java   java如何使用Hibernate获取不完整的集合?   打印无法从java连接到打印机   java使用分隔符拆分带引号的字符串   java Axis2禁用严格验证(wsdl2java中的Eosv)允许什么,如何使其更加严格?   java有人能帮我处理循环代码吗   java将JsonObject数组转换为整数   JavaXWiki扩展:检测事件空间创建   java如何设置图表的文本方向以使用poi旋转所有文本?   eche RecyclerView项的java Set自定义字体   java单元测试带有私有构造函数的spring组件,无需注入   用户界面如何在java中动态显示一组多个元素?   如何从java应用程序调用IDL(交互式数据语言)?   Java的内置库实现