跳转到主要内容

Atwiki客户端库

项目描述

GitHubActions CodeCov PyPI

atwiki-python

atwiki-python 是一个用于从Python访问 @wiki 的客户端库。

此包还包括用于从 @wiki 维基站点导出源代码的 atwiki-dump 命令。

安装

pip install atwiki-python

要求

  • Python 2.7 / 3.7 / 3.8 / 3.9 / 3.10 / 3.11

使用方法

atwiki-dump 命令

导出维基站点中每个页面的源代码和页面名称。

atwiki-dump -o /tmp/dump_dir https://w.atwiki.jp/python-client/

Python API

Python API提供对 @wiki 功能的访问。

from atwiki import *

api = AtWikiAPI(AtWikiURI('https://w.atwiki.jp/python-client/'))

# Show list of tags.
for tag in api.get_tags():
    print(tag)

# Show list of pages.
for page in api.get_list():
    print(page)

# Show list of pages tagged with 'tag01'.
for page in api.get_list('tag01'):
    print(page)

# Show source of page ID 14.
print(api.get_source(14))

# Show results of wiki search.
for result in api.search('test'):
    print(result)

提示

  • 请始终在请求之间使用合适的间隔,否则您的IP地址可能会被禁用。经验表明,API调用之间10秒的睡眠时间就足够了。每个 AtWikiAPI 实例都会自动在请求之间注入延迟。

  • 您的应用程序必须预期从API返回的条目可能在页面/标签在API调用期间添加/删除时重复/缺失。这是因为列表请求是内部分页的,保证一致性代价高昂。

  • AtWiki的规范可能随时更改。如果您打算构建自动化系统,建议在运行应用程序之前每次都运行与此库安装一起提供的测试套件(python -m unittest discover atwiki)。

许可协议

MIT许可

项目详情


下载文件

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

源代码分布

atwiki-python-0.0.11.tar.gz (11.6 kB 查看哈希)

上传时间 源代码

构建分布

atwiki_python-0.0.11-py3-none-any.whl (13.6 kB 查看哈希)

上传时间 Python 3

由以下支持