mwclient, mwclient是一个 python 客户端库,用于与MediaWiki接口

分享于 

4分钟阅读

GitHub

  繁體 雙語
mwclient is a Python framework to interface with the MediaWiki API.
  • 源代码名称:mwclient
  • 源代码网址:http://www.github.com/mwclient/mwclient
  • mwclient源代码文档
  • mwclient源代码下载
  • Git URL:
    git://www.github.com/mwclient/mwclient.git
    Git Clone代码到本地:
    git clone http://www.github.com/mwclient/mwclient
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/mwclient/mwclient
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    Logo

    mwclient

    Build statusTest coverageCode healthLatest versionDownloadsMIT licenseDocumentation statusIssue statistics

    mwclient是MediaWiki的轻量级 python 客户端库,它提供对大多数API功能的访问。 它适用于 python 2.7.3.3和上,并支持 MediaWiki 1.16和上。 对于当前MediaWiki中不可用的函数,将引发 MediaWikiVersionError

    当前稳定的版本 0.8.7 是通过PyPI的:

    $ pip install mwclient

    当前的开发版本插件可以从GitHub安装:

    $ pip install git+git://github.com/mwclient/mwclient.git

    请查看变更日志文档以获得更改列表。

    正在启动

    请参见用户指南以开始使用 mwclient。

    有关更多信息,请参见文件和wiki上的文档

    mwclient附带了一个基于 pytest的测试套件。 目前只有一小部分的mwclient被测试,但希望覆盖率将在未来改进。

    运行测试的最简单方法是:

    $ python setup.py test

    如果需要,这将在本地构建和下载测试依赖项。 要使测试快速运行,你可以使用pip来执行 "可以编辑"安装插件:

    $ pip install pytest pytest-pep8 responses$ pip install -e .$ py.test

    要在独立virtualenvs中使用不同的python 版本运行测试,可以使用 Tox:

    $ pip install tox$ tox

    文档由手工编译的用户指南( 在 docs/user 下) 和从文档文档生成的参考指南组成,使用Sphinx的autodoc和拿破仑的扩展。 文档在每次提交后自动在 ReadTheDocs 上生成。 要在本地构建文档进行测试,请执行以下操作:

    $ cd docs$ make html

    在写文档文件时,尝试遵循的Google风格

    实现说明

    大多数属性和生成器接受与API相同的参数,但没有两个字母前缀。 这里规则的例外情况:

    • Image.imageinfo 是最新图像的imageinfo。 可以使用 imagehistory() 获取早期版本
    • Site.all*: 参数 [ap]from 重命名为 start
    • categorymembers 是作为 Category.members 实现
    • deletedrevsdeletedrevisions
    • usercontribsusercontributions
    • searchusercontributions的第一个参数分别是 searchuser

    属性和生成器作为 python 生成器实现。 它们的限制参数只是一个块中项目数量的一个指示。 这不是总限制。 执行 list(generator(limit = limit)) 将返回生成器的所有项,而不受限制值的限制。 默认块大小通常是最大块大小。