跳转到主要内容

MarkLogic 8的REST客户端

项目描述

MarkLogic 8文档管理的REST客户端。

MarkLogic 8是用于文档管理应用程序的NOSQL数据库和应用框架。

此包仍处于早期WIP状态,API可能在首次发布之前发生变化。

如副标题所述,此包专注于文档管理服务(CRUD操作、搜索等)。如果您需要一种Pythonic的方式来创建、微调和填充MarkLogic 8数据库和集群,您可能更喜欢MarkLogic_Python

嘿!文档在哪里

如上所述,此包处于开发早期阶段,在API和功能可能在前一个beta版本之前发生变化的情况下编写一个酷炫的文档是浪费时间。

同时,您可以在sandbox/目录中阅读和尝试代码,该目录探索了提供的资源的大部分功能。

安装

如果您想获取完整的源分发并为此项目做出贡献,请跳转到贡献。其他人将使用pip安装mllib,如下所示,只要它尚未在PyPI上提供。

pip install git+https://github.com/glenfant/mllib.git#egg=mllib

如果您需要特定的Git分支、标记或提交哈希,请参阅https://pip.pythonlang.cn/en/latest/reference/pip_install.html#git

开发者说明

请使用virtualenv来维护此包,但我不必说这一点。

从SCM仓库获取源代码

$ git clone https://github.com/glenfant/mllib.git
$ python setup.py develop
$ pip install mllib[dev]

运行测试

运行测试需要

  • 连接到http://httpbin.org/。如果您可以在浏览器中看到其主页,则一切正常

  • 在本地服务器上运行MarkLogic 8 REST测试实例,用户名和密码都是admin。如果您想使用另一个实例,该实例监听主机my.marklogic-rest.tld的端口9000,并且用户是foo,通过密码bar认证,您需要在包含my.marklogic-rest.tld:9000:foo:barMLLIB_TEST_SERVER环境变量中提供这些信息。

    如果您的MarkLogic REST服务器期望一个HTTP基本认证令牌,请在MLLIB_TEST_SERVER环境变量中附加:basic。否则将颁发HTTP摘要认证令牌。

$ export MLLIB_TEST_SERVER=my.marklogic-rest.tld:9000:foo:bar  # Optional
$ python setup.py test
$ python run_tests.py

构建Sphinx文档

$ python setup.py build_sphinx
$ firefox build/sphinx/html/index.html

贡献

  • 如果尚未完成,请注册Github

  • 请在Github跟踪器中提交一个工单,解释您的功能或改进。

  • 在您的个人仓库中分叉项目

  • 完成工作

  • 始终检查现有的单元测试(见上面),并添加验证您的功能或错误修复的单元测试。

  • 在同步原始master时,优先使用“git rebase”而不是“git merge”。请参阅http://blog.bigbinary.com/2013/09/13/how-to-keep-your-fork-uptodate.html中的工作流程解释。

  • 完成时,发起一个拉取请求,并提及在第2步中创建的原始工单。

  • 如果您喜欢这个项目,别忘了在Github上“star”它。 ;)

鸣谢

此库的开发由法国国民议会赞助。

许可证

此软件根据MIT许可条款分发。

变更日志

1.0.0a2

  • 修复了打包问题[glenfant]

1.0.0a1

没有变化。只是版本规范化。

1.0.0.a1

首次发布。

  • 使用bobtemplates.gillux创建软件包[glenfant]

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

mllib-1.0.0a2.tar.gz (12.5 kB 查看哈希值)

上传时间

支持者:

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面