Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

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.3, 3.4, 3.5 or 3.6.

Usage

atwiki-dump Tool

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

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

Python API

Python API provides access to @wiki features.

from atwiki import *

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

# Show list of tags.
for page in api.get_tags():
  print(page['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.

Filename, size & hash SHA256 hash help File type Python version Upload date
atwiki-python-0.0.4.tar.gz (7.8 kB) Copy SHA256 hash SHA256 Source None Jan 24, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page