{"id":15360809,"url":"https://github.com/kmaehashi/atwiki-python","last_synced_at":"2025-04-15T08:21:57.678Z","repository":{"id":10311102,"uuid":"65304466","full_name":"kmaehashi/atwiki-python","owner":"kmaehashi","description":"@wiki Client for Python","archived":false,"fork":false,"pushed_at":"2024-09-04T00:55:16.000Z","size":80,"stargazers_count":7,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T18:09:14.643Z","etag":null,"topics":["python","python3","scraper","wiki"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kmaehashi.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["LyricsMaster"]}},"created_at":"2016-08-09T15:04:21.000Z","updated_at":"2024-09-30T07:52:23.000Z","dependencies_parsed_at":"2022-08-17T21:25:38.739Z","dependency_job_id":null,"html_url":"https://github.com/kmaehashi/atwiki-python","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmaehashi%2Fatwiki-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmaehashi%2Fatwiki-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmaehashi%2Fatwiki-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kmaehashi%2Fatwiki-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kmaehashi","download_url":"https://codeload.github.com/kmaehashi/atwiki-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249032072,"owners_count":21201399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python","python3","scraper","wiki"],"created_at":"2024-10-01T12:51:48.886Z","updated_at":"2025-04-15T08:21:57.661Z","avatar_url":"https://github.com/kmaehashi.png","language":"Python","funding_links":["https://github.com/sponsors/LyricsMaster"],"categories":[],"sub_categories":[],"readme":"|GitHubActions|_ |CodeCov|_ |PyPi|_\n\n.. |GitHubActions| image:: https://github.com/kmaehashi/atwiki-python/actions/workflows/test.yml/badge.svg?branch=main\n.. _GitHubActions: https://github.com/kmaehashi/atwiki-python/actions/workflows/test.yml?query=branch%3Amain\n\n.. |CodeCov| image:: https://codecov.io/gh/kmaehashi/atwiki-python/branch/main/graph/badge.svg\n.. _CodeCov: https://codecov.io/gh/kmaehashi/atwiki-python\n\n.. |PyPI| image:: https://badge.fury.io/py/atwiki-python.svg\n.. _PyPI: https://pypi.org/project/atwiki-python\n\natwiki-python\n=============\n\n``atwiki-python`` is a client library to access `@wiki \u003chttps://atwiki.jp/\u003e`_ from Python.\n\nThis package also includes ``atwiki-dump`` command to dump source from @wiki wiki site.\n\nInstall\n-------\n\n::\n\n  pip install atwiki-python\n\nRequirements\n------------\n\n* Python 2.7 / 3.7 / 3.8 / 3.9 / 3.10 / 3.11\n\nUsage\n-----\n\n``atwiki-dump`` Command\n~~~~~~~~~~~~~~~~~~~~~~~\n\nDump source and page name for each page in the wiki site.\n\n::\n\n  atwiki-dump -o /tmp/dump_dir https://w.atwiki.jp/python-client/\n\nPython API\n~~~~~~~~~~\n\nPython API provides access to @wiki features.\n\n.. code:: python\n\n  from atwiki import *\n\n  api = AtWikiAPI(AtWikiURI('https://w.atwiki.jp/python-client/'))\n\n  # Show list of tags.\n  for tag in api.get_tags():\n      print(tag)\n\n  # Show list of pages.\n  for page in api.get_list():\n      print(page)\n\n  # Show list of pages tagged with 'tag01'.\n  for page in api.get_list('tag01'):\n      print(page)\n\n  # Show source of page ID 14.\n  print(api.get_source(14))\n\n  # Show results of wiki search.\n  for result in api.search('test'):\n      print(result)\n\nHints\n-----\n\n* Always use an appropraite interval between requests, or your IP address may get banned.\n  Empirically, 10 seconds of sleep between API call is sufficient.\n  Each ``AtWikiAPI`` instance automatically injects a delay between requests.\n* Your application must expect that entries returned from APIs may be duplicate/missing when pages/tags are added/removed during API call.\n  This is because listing requests are internally pagerized and it is costly to guarantee consistency.\n* AtWiki's specification may change anytime.\n  If you are going to build an automated system, it is encouraged to run test suites included with the installation of this library (``python -m unittest discover atwiki``) everytime before running your application.\n\nLicense\n-------\n\nMIT License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkmaehashi%2Fatwiki-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkmaehashi%2Fatwiki-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkmaehashi%2Fatwiki-python/lists"}