Skip to content

Commit 9448afb

Browse files
authored
Merge pull request #32 from kmaehashi/update-readme
Update README.rst
2 parents b0c3212 + ed67555 commit 9448afb

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
|GitHubActions|_ |CodeCov|_ |PyPi|_
22

33
.. |GitHubActions| image:: https://github.com/kmaehashi/atwiki-python/actions/workflows/test.yml/badge.svg?branch=master
4-
.. _GitHubActions: https://github.com/kmaehashi/atwiki-python/actions/workflows/test.yml
4+
.. _GitHubActions: https://github.com/kmaehashi/atwiki-python/actions/workflows/test.yml?query=branch%3Amaster
55

66
.. |CodeCov| image:: https://codecov.io/gh/kmaehashi/atwiki-python/branch/master/graph/badge.svg
77
.. _CodeCov: https://codecov.io/gh/kmaehashi/atwiki-python
88

9-
.. |PyPi| image:: https://badge.fury.io/py/atwiki-python.svg
10-
.. _PyPi: https://badge.fury.io/py/atwiki-python
9+
.. |PyPI| image:: https://badge.fury.io/py/atwiki-python.svg
10+
.. _PyPI: https://pypi.org/project/atwiki-python
1111

1212
atwiki-python
1313
=============
@@ -53,28 +53,29 @@ Python API provides access to @wiki features.
5353
5454
# Show list of tags.
5555
for tag in api.get_tags():
56-
print(tag)
56+
print(tag)
5757
5858
# Show list of pages.
5959
for page in api.get_list():
60-
print(page)
60+
print(page)
6161
6262
# Show list of pages tagged with 'tag01'.
6363
for page in api.get_list('tag01'):
64-
print(page)
64+
print(page)
6565
6666
# Show source of page ID 14.
6767
print(api.get_source(14))
6868
6969
# Show results of wiki search.
7070
for result in api.search('test'):
71-
print(result)
71+
print(result)
7272
7373
Hints
7474
-----
7575

7676
* Always use an appropraite interval between requests, or your IP address may get banned.
7777
Empirically, 10 seconds of sleep between API call is sufficient.
78+
Each ``AtWikiAPI`` instance automatically injects a delay between requests.
7879
* Your application must expect that entries returned from APIs may be duplicate/missing when pages/tags are added/removed during API call.
7980
This is because listing requests are internally pagerized and it is costly to guarantee consistency.
8081
* AtWiki's specification may change anytime.

0 commit comments

Comments
 (0)