atwiki-python

atwiki-python is a client library to access @wiki from Python.

This package also includes atwiki-dump command to dump source from @wiki wiki site.

Install

pip install atwiki-python

Requirements

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

Usage

atwiki-dump Command

Dump source and page name for each page in the wiki site.

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

Python API

Python API provides access to @wiki features.

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)

Hints

Always use an appropraite interval between requests, or your IP address may get banned. Empirically, 10 seconds of sleep between API call is sufficient. Each AtWikiAPI instance automatically injects a delay between requests.
Your application must expect that entries returned from APIs may be duplicate/missing when pages/tags are added/removed during API call. This is because listing requests are internally pagerized and it is costly to guarantee consistency.
AtWiki’s specification may change anytime. If you are going to build an automated system, it is encouraged to run test suites included with the installation of this library (python -m unittest discover atwiki) everytime before running your application.

License

MIT License

Metadata

Release files for atwiki-python 0.0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for atwiki-python 0.0.11
File	Size	Uploaded
atwiki-python-0.0.11.tar.gz	11.6 kB	Jul 15, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for atwiki-python 0.0.11
File	Interpreter	ABI	Platform	Reset
atwiki_python-0.0.11-py3-none-any.whl 13.6 kB Jul 15, 2023	Python 3	none	any	Details

Total release size: 25.3 kB

Release files / atwiki-python-0.0.11.tar.gz

Download URL	atwiki-python-0.0.11.tar.gz
Size	11.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`ee0103b98eb702d4b85c8aa63d33e58cd83eb9d595c2447bc918ac961363384d`
BLAKE2b-256 checksum How to use checksums	`97fadcfa08853f3c15b4ca32b2db1db4b1528134296516e05cc7f8c83bfe28fb`
Upload date	Jul 15, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.2 CPython/3.11.4`

Release files / atwiki_python-0.0.11-py3-none-any.whl

Download URL	atwiki_python-0.0.11-py3-none-any.whl
Size	13.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`d35d7982ad19e1fa07be762f4a156100390f8f309811151ad62c7e81adb1f76c`
BLAKE2b-256 checksum How to use checksums	`70a667bc73ea20466f171dfa66d3dd7edcff8ed7fb30d9928245ba3cfbb339af`
Upload date	Jul 15, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/4.0.2 CPython/3.11.4`