Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kmaehashi committed Aug 9, 2016
1 parent bdae5bb commit dca2997
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.rst
Expand Up @@ -14,6 +14,8 @@ atwiki-python

``atwiki-python`` is a client library to access `@wiki <https://atwiki.jp/>`_ from Python.

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

Install
-------

Expand All @@ -29,21 +31,35 @@ Requirements
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.

.. code:: python
from atwiki import *
api = AtWikiAPI(AtWikiURI('http://www65.atwiki.jp/python-client/'))
# List of pages.
# Show list of pages.
for page in api.get_list():
print(page['name'])
# List of pages tagged with 'tag01'.
# Show list of pages tagged with 'tag01'.
for page in api.get_list('tag01'):
print(page['name'])
# Source of page ID 14
# Show source of page ID 14.
print(api.get_source(14))
License
Expand Down

0 comments on commit dca2997

Please sign in to comment.