File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -14,6 +14,8 @@ atwiki-python
1414
1515``atwiki-python `` is a client library to access `@wiki <https://atwiki.jp/ >`_ from Python.
1616
17+ This package also includes ``atwiki-dump `` command to dump source from @wiki wiki site.
18+
1719Install
1820-------
1921
@@ -29,21 +31,35 @@ Requirements
2931Usage
3032-----
3133
34+ ``atwiki-dump `` Tool
35+ ~~~~~~~~~~~~~~~~~~~~
36+
37+ Dump source and page name for each page in the wiki site.
38+
39+ ::
40+
41+ atwiki-dump -o /tmp/dump_dir http://www65.atwiki.jp/python-client/
42+
43+ Python API
44+ ~~~~~~~~~~
45+
46+ Python API provides access to @wiki features.
47+
3248.. code :: python
3349
3450 from atwiki import *
3551
3652 api = AtWikiAPI(AtWikiURI(' http://www65.atwiki.jp/python-client/' ))
3753
38- # List of pages.
54+ # Show list of pages.
3955 for page in api.get_list():
4056 print (page[' name' ])
4157
42- # List of pages tagged with 'tag01'.
58+ # Show list of pages tagged with 'tag01'.
4359 for page in api.get_list(' tag01' ):
4460 print (page[' name' ])
4561
46- # Source of page ID 14
62+ # Show source of page ID 14.
4763 print (api.get_source(14 ))
4864
4965 License
You can’t perform that action at this time.
0 commit comments