Skip to content

kmaehashi/atwiki-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 .

Requirements

  • Python 2.6, 2.7, 3.3, 3.4 or 3.5.

Usage

atwiki-dump Tool

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

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

Python API

Python API provides access to @wiki features.

from atwiki import *

api = AtWikiAPI(AtWikiURI('http://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