Skip to main content

Atwiki Client Library

Project description

Travis Coveralls PyPi

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.5, 3.6 or 3.7.

Usage

atwiki-dump Tool

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['name'])

# Show list of pages.
for page in api.get_list():
  print(page['name'])

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

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

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

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

atwiki-python-0.0.5.tar.gz (8.0 kB view details)

Uploaded Source

File details

Details for the file atwiki-python-0.0.5.tar.gz.

File metadata

  • Download URL: atwiki-python-0.0.5.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/2.7.16

File hashes

Hashes for atwiki-python-0.0.5.tar.gz
Algorithm Hash digest
SHA256 74c91ef0235d737182545ceed0905e628773265a2d74c23e0ecb2da3d8b3e212
MD5 05c75fe6f310e5bd2f01f7c37c78c549
BLAKE2b-256 c035c38b444639134cba06ca230b2d31c86b37b58bdd04089bfb0009968bcaaf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page