{ "info": { "author": "Hikaru ETO", "author_email": "kitadakyou@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Natural Language :: Japanese", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# PyBacklogPy\n\n[![CircleCI](https://circleci.com/gh/kitadakyou/PyBacklogPy/tree/master.svg?style=svg)](https://circleci.com/gh/kitadakyou/PyBacklogPy/tree/master)\n\n## \u3053\u308c\u306f\u4f55\uff1f\n\n[BacklogAPI](https://developer.nulab.com/ja/docs/backlog/) \u3092 Python \u304b\u3089\u7c21\u5358\u306b\u547c\u3079\u308b\u3088\u3046\u306b\u30e9\u30c3\u30d7\u3057\u305f\u3082\u306e\u3067\u3059\u3002\n\n## \u5fc5\u9808\u74b0\u5883\n\n- `Python 3.5` \u4ee5\u4e0a\n - `typing` \u30e2\u30b8\u30e5\u30fc\u30eb\u3092\u4f7f\u7528\u3057\u3066\u3044\u308b\u305f\u3081\n - \u958b\u767a\u304a\u3088\u3073\u30c6\u30b9\u30c8\u74b0\u5883\u306f `Python 3.7.3` \u3092\u4f7f\u7528\n\n## \u4f7f\u3044\u65b9\n\n\u8a73\u7d30\u306a\u4ed5\u69d8\u306b\u3064\u3044\u3066\u306f[\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8](https://kitadakyou.github.io/PyBacklogPy/)\u3092\u53c2\u7167\u3057\u3066\u304f\u3060\u3055\u3044\n\n### \u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\n\npip \u304b\u3089\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3057\u307e\u3059\u3002\n\n```bash\npip install pybacklogpy\n```\n\n### \u30c9\u30e1\u30a4\u30f3\u304a\u3088\u3073\u30b7\u30fc\u30af\u30ec\u30c3\u30c8\u30ad\u30fc\u306e\u767b\u9332\n\n\u30c9\u30e1\u30a4\u30f3\u53ca\u3073\u30b7\u30fc\u30af\u30ec\u30c3\u30c8\u30ad\u30fc\u3092\u767b\u9332\u3059\u308b\u306b\u306f\u4ee5\u4e0b\u306e2\u7a2e\u985e\u306e\u65b9\u6cd5\u304c\u3042\u308a\u307e\u3059\u3002\n\n1. \u30d7\u30ed\u30b0\u30e9\u30e0\u4e0a\u3067\u6307\u5b9a\u3059\u308b\n1. \u8a2d\u5b9a\u30d5\u30a1\u30a4\u30eb\u3092\u7f6e\u304f\n\n\u306a\u304a\u3001\u3069\u3061\u3089\u3082\u8a2d\u5b9a\u3057\u3066\u3044\u305f\u5834\u5408\u3001 __\u30d7\u30ed\u30b0\u30e9\u30e0\u4e0a\u3067\u6307\u5b9a\u3059\u308b__ \u306e\u65b9\u304c\u512a\u5148\u3055\u308c\u307e\u3059\u3002\n\n#### \u30d7\u30ed\u30b0\u30e9\u30e0\u4e0a\u3067\u8a2d\u5b9a\u3059\u308b\u5834\u5408\n\nBacklog\u306e\u30c9\u30e1\u30a4\u30f3\u5225\u306b\u4ee5\u4e0b3\u7a2e\u985e\u306e\u30af\u30e9\u30b9\u3092\u7528\u610f\u3057\u3066\u3044\u307e\u3059\u3002\n\n- BacklogComConfigure (backlog.com)\n- BacklogJpConfigure (backlog.jp)\n- BacklogToolConfigure (backlogtool.com)\n\n\u3053\u306e\u30af\u30e9\u30b9\u306e\u30b3\u30f3\u30b9\u30c8\u30e9\u30af\u30bf\u5f15\u6570\u3068\u3057\u3066\u3001\u30b9\u30da\u30fc\u30b9ID \u3068 API \u306e\u30ad\u30fc\u3092\u6e21\u3059\u3053\u3068\u3067\u8a2d\u5b9a\u3092\u884c\u3048\u307e\u3059\u3002\n\n\u4f8b\u3048\u3070\u3001\u4e0b\u8a18\u306e\u3088\u3046\u306a\u5834\u5408\n- Backlog\u30c9\u30e1\u30a4\u30f3: `kitadakyou.backlog.com` \n- API \u30ad\u30fc: `qwertyuiopasdfghjklzxcvbnmqazwsxedcrfvtgbyhnujmikolp`\n\n\u30b3\u30fc\u30c9\u306f\u6b21\u306e\u3088\u3046\u306b\u306a\u308a\u307e\u3059\u3002\n\n```python\nfrom pybacklogpy.BacklogConfigure import BacklogComConfigure\nfrom pybacklogpy.Issue import Issue\n\n# Configure \u30af\u30e9\u30b9\u306e\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u3092\u751f\u6210\nconfig = BacklogComConfigure(space_key='kitadakyou',\n api_key='qwertyuiopasdfghjklzxcvbnmqazwsxedcrfvtgbyhnujmikolp')\n\n\nissue_api = Issue(config) # API \u3092\u547c\u3076\u30af\u30e9\u30b9\u306e\u30b3\u30f3\u30b9\u30c8\u30e9\u30af\u30bf\u5f15\u6570\u3068\u3057\u3066 Configure \u30af\u30e9\u30b9\u306e\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u306f\u4f7f\u7528\u53ef\u80fd \nresponse = issue_api.get_issue_list()\n\nissue_api_2 = Issue() # Configure \u30af\u30e9\u30b9\u3092\u6e21\u3055\u306a\u304b\u3063\u305f\u5834\u5408\u306f\u3001\u6b21\u3067\u7d39\u4ecb\u3059\u308b\u8a2d\u5b9a\u30d5\u30a1\u30a4\u30eb\u306e\u60c5\u5831\u3092\u8aad\u307f\u306b\u884c\u304f\nresponse_2 = issue_api_2.get_issue_list()\n\n```\n\n#### \u8a2d\u5b9a\u30d5\u30a1\u30a4\u30eb\u3067\u6307\u5b9a\u3059\u308b\u5834\u5408\n\n\u4f7f\u7528\u3059\u308b\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u306e\u76f4\u4e0b\u306b `secrets` \u3068\u3044\u3046\u30d5\u30a1\u30a4\u30eb\u3092\u4f5c\u308a\u3001\u4ee5\u4e0b\u306e\u3088\u3046\u306b\u5024\u3092\u5165\u308c\u3066\u304a\u3044\u3066\u304f\u3060\u3055\u3044\u3002\n\u306a\u304a\u3001\u5f53\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u76f4\u4e0b\u306b\u3042\u308b `secrets_sample` \u3092\u30b3\u30d4\u30fc\u3059\u308b\u3068\u697d\u3067\u3059\u3002\n\n\u306a\u304a\u3001\u3053\u306e\u30d5\u30a1\u30a4\u30eb\u306f\u8aa4\u3063\u3066\u30ea\u30dd\u30b8\u30c8\u30ea\u306b\u3042\u3052\u306a\u3044\u3088\u3046\u3001 `.gitignore` \u306b\u8ffd\u52a0\u3057\u3066\u304a\u304f\u3053\u3068\u3092\u63a8\u5968\u3057\u307e\u3059\n\n```ini\n[backlog]\nHost = kitadakyou.backlog.com\nApiKey = qwertyuiopasdfghjklzxcvbnmqazwsxedcrfvtgbyhnujmikolp\n```\n\n### \u30e2\u30b8\u30e5\u30fc\u30eb\u3092\u8aad\u307f\u8fbc\u307f\u3001\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u751f\u6210\n\n\u4f7f\u7528\u3059\u308b\u30e2\u30b8\u30e5\u30fc\u30eb\u3092\u30ed\u30fc\u30c9\u3057\u307e\u3059\u3002\n\u305d\u308c\u305e\u308c\u306f\u30af\u30e9\u30b9\u306b\u306a\u3063\u3066\u3044\u308b\u306e\u3067\u3001\u305d\u306e\u30a4\u30f3\u30b9\u30bf\u30f3\u30b9\u3092\u751f\u6210\u3057\u307e\u3059\u3002\n\n\u4f8b\u3068\u3057\u3066\u3001Wiki \u306e API \u3092\u547c\u3073\u305f\u3044\u3068\u8003\u3048\u307e\u3059\u3002\n\n```python:sample.py\nfrom pybacklogpy.Wiki import Wiki\n\n\nwiki_api = Wiki()\n\n```\n\n### API \u3092\u547c\u3076\n\n\u3069\u306e\u3088\u3046\u306a API \u304c\u3042\u308b\u304b\u306f [PyBacklogPy \u306e\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8](https://kitadakyou.github.io/PyBacklogPy/)\u3001\u3082\u3057\u304f\u306f [BacklogAPI \u306e\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8](https://developer.nulab.com/ja/docs/backlog/)\u3092\u53c2\u7167\u3057\u3066\u304f\u3060\u3055\u3044\u3002\n\u307e\u305f\u3001\u30d7\u30ed\u30b8\u30a7\u30af\u30c8ID \u3084 Wiki ID \u7b49\u306e\u8abf\u3079\u65b9\u306f\u2026\u30b0\u30b0\u308c\u3070\u3059\u3050\u306b\u51fa\u3066\u304d\u307e\u3059\n\nWiki \u3092\u8ffd\u52a0\u3059\u308b\u30b5\u30f3\u30d7\u30eb\n\n```python:sample3.py\nfrom pybacklogpy.Wiki import Wiki\n\n\nwiki_api = Wiki()\n\n\nresponse = wiki_api.add_wiki_page(\n project_id=1000,\n name='SampleWikiName',\n content='\u30b5\u30f3\u30d7\u30eb Wiki \u672c\u6587',\n mail_notify=False,\n)\n\n```\n\nWiki \u3092\u66f4\u65b0\u3059\u308b\u30b5\u30f3\u30d7\u30eb\n\n```python:sample3.py\nfrom pybacklogpy.Wiki import Wiki\n\n\nwiki_api = Wiki()\n\n\nresponse = wiki_api.update_wiki_page(\n wiki_id=12345,\n name='TestWikiName',\n content='\u30c6\u30b9\u30c8 \u672c\u6587',\n mail_notify=False,\n)\n\n```\n\n### \u8fd4\u308a\u5024\u3092\u898b\u308b\n\n\u5168\u3066\u306e\u95a2\u6570\u306f [request](https://requests-docs-ja.readthedocs.io/en/latest/) \u306e [\u30ec\u30b9\u30dd\u30f3\u30b9\u30aa\u30d6\u30b8\u30a7\u30af\u30c8](https://requests-docs-ja.readthedocs.io/en/latest/user/quickstart/#id3) \u3092\u8fd4\u3057\u307e\u3059\u3002\n\n\u30ea\u30af\u30a8\u30b9\u30c8\u304c\u6210\u529f\u3057\u3066\u3044\u308b\u304b\u3092\u78ba\u8a8d\u3059\u308b\u306b\u306f\u3001 `response.ok` \u3092\u898b\u308b\u306e\u304c\uff11\u756a\u65e9\u3044\u3067\u3059\u3002\n\nWiki \u306e\u66f4\u65b0\u304c\u6210\u529f\u3057\u3066\u3044\u308b\u304b\u78ba\u8a8d\u3059\u308b\u30b5\u30f3\u30d7\u30eb\n\n```python:sample4.py\nfrom pybacklogpy.Wiki import Wiki\n\n\nwiki_api = Wiki()\n\n\nresponse = wiki_api.update_wiki_page(\n wiki_id=12345,\n name='TestWikiName',\n content='\u30c6\u30b9\u30c8 \u672c\u6587',\n mail_notify=False,\n)\nif not response.ok:\n raise ValueError('Wiki \u306e\u66f4\u65b0\u306b\u5931\u6557')\n\n```\n\n\u307e\u305f\u3001\u30ec\u30b9\u30dd\u30f3\u30b9\u672c\u6587\u306f `response.text` \u306e\u4e2d\u8eab\u306b\u751f(=\u30c6\u30ad\u30b9\u30c8\u306e)\u306e JSON \u304c\u5165\u3063\u3066\u3044\u307e\u3059\u3002\u6a19\u6e96\u30e9\u30a4\u30d6\u30e9\u30ea `json` \u3092\u4f7f\u3063\u3066 parse \u3057\u3066\u3042\u3052\u308c\u3070\u3001\u7c21\u5358\u306b\u4f7f\u3048\u307e\u3059\u3002\n\nWiki \u306e\u5185\u5bb9\u3092\u53d6\u5f97\u3059\u308b\u30b5\u30f3\u30d7\u30eb\n\n```python:sample5.py\nimport json\n\n\nfrom pybacklogpy.Wiki import Wiki\n\n\nwiki_api = Wiki()\n\n\nresponse = wiki_api.get_wiki_page(\n wiki_id=12345,\n)\n\nif not response.ok:\n raise ValueError('Wiki \u30da\u30fc\u30b8\u60c5\u5831\u306e\u53d6\u5f97\u306b\u5931\u6557')\n\nwiki_data = json.loads(response.text)\nwiki_name = wiki_data['name']\nwiki_content = wiki_data['content']\n\n```\n\n### \u30d5\u30a1\u30a4\u30eb\u306e\u53d6\u5f97\n\n\u30d5\u30a1\u30a4\u30eb\u53d6\u5f97\u306b\u3064\u3044\u3066\u306f\u3001\u7279\u6b8a\u306a\u8fd4\u308a\u5024\u306e\u305f\u3081\u3001\u5225\u9014\u3053\u3061\u3089\u3067\u8aac\u660e\u3057\u307e\u3059\u3002\n\n\u30d5\u30a1\u30a4\u30eb\u3092\u53d6\u5f97\u3059\u308b\u95a2\u6570\u3092\u4f7f\u7528\u3059\u308b\u5834\u5408\u306f\u3001\u307e\u305a\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u3092\u4f5c\u6210\u3059\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002\n\u30c7\u30d5\u30a9\u30eb\u30c8\u3067\u306f\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u76f4\u4e0b\u306e `/tmp` \u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u306b\u30d5\u30a1\u30a4\u30eb\u304c\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9\u3055\u308c\u307e\u3059\u3002(\u4eca\u306e\u6240\u3001\u5909\u66f4\u4e0d\u53ef\ud83d\udca6)\n\n\u30d5\u30a1\u30a4\u30eb\u3092\u53d6\u5f97\u3059\u308b\u95a2\u6570\u306f\u300c1\u756a\u76ee\u304c\u30d5\u30a1\u30a4\u30eb\u306ePATH\u300d\u3001\u300c2\u756a\u76ee\u304c\u30ec\u30b9\u30dd\u30f3\u30b9\u30aa\u30d6\u30b8\u30a7\u30af\u30c8\u300d\u306e\u30bf\u30d7\u30eb\u3092\u8fd4\u3057\u307e\u3059\u3002\n\u305d\u306e\u305f\u3081\u3001\u4e00\u5ea6\u306b\u53d7\u3051\u53d6\u308b\u306b\u306f\u3001\u4ee5\u4e0b\u306e\u3088\u3046\u306b\u8fd4\u308a\u5024\u3092\u53d7\u3051\u53d6\u308b\u5909\u6570\u30922\u3064\u7528\u610f\u3059\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002\n\n```python:sample3.py\nfrom pybacklogpy.Wiki import Wiki\n\n\nwiki_api = Wiki()\n\n\ndownloaded_file_path, response = self.wiki_attachment.get_wiki_page_attachment(\n wiki_id=12345,\n attachment_id=987654,\n)\nprint(downloaded_file_path)\n```\n\n## \u30d0\u30b0\u3092\u898b\u3064\u3051\u305f\u3089\n\n\u81ea\u7531\u306b\u30d6\u30e9\u30f3\u30c1\u3092\u5207\u3063\u3066\u3001 PullRequest \u3092\u51fa\u3057\u3066\u304f\u3060\u3055\u3044\u3002Issue \u3092\u4e0a\u3052\u308b\u3060\u3051\u3067\u3082\u5927\u4e08\u592b\u3067\u3059\u3002\n\u4e00\u9031\u9593\u306b\u4e00\u56de\u304f\u3089\u3044\u306f\u898b\u308b\u3088\u3046\u306b\u3059\u308b\u306e\u3067\u3001\u5bfe\u5fdc\u51fa\u6765\u305f\u3089\u5bfe\u5fdc\u3057\u307e\u3059\u3002(\u5168\u3066\u5bfe\u5fdc\u3059\u308b\u3068\u306f\u8a00\u3063\u3066\u3044\u306a\u3044)\n\n\u3082\u3057\u3001PR\u51fa\u3057\u3066\u3082\u5168\u304f\u30ea\u30a2\u30af\u30b7\u30e7\u30f3\u304c\u306a\u3044\u5834\u5408\u306f Twitter \u306e [kitadakyou](https://twitter.com/kitadakyou) \u3001\u82e5\u3057\u304f\u306f\u4f5c\u8005\u306e\u30e1\u30fc\u30eb\u5b9b\u306b\u3054\u9023\u7d61\u304f\u3060\u3055\u3044\u3002\n\n## \u304a\u307e\u3051: \u306a\u3093\u3067\u3053\u3093\u306a\u540d\u524d\u306a\u306e\uff1f\n\n`PyBacklog` \u3082 `BacklogPy` \u3082\u65e2\u306b\u5b58\u5728\u3057\u305f\u306e\u3067\u3001\u82e6\u8089\u306e\u7b56\u3067 Py \u3067\u631f\u307f\u307e\u3057\u305f\u3002 \n\u3082\u3057\u3001`PyBacklogPy` \u3082\u5b58\u5728\u3057\u305f\u3089\u3001 `PyBacklogXPyBacklog` \u3068\u3044\u3046 HUNTER\u00d7HUNTER \u65b9\u5f0f\u3067\u884c\u3053\u3046\u3068\u8003\u3048\u3066\u3044\u307e\u3057\u305f\u3002\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://kitadakyou.github.io/PyBacklogPy/", "keywords": "", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "pybacklogpy", "package_url": "https://pypi.org/project/pybacklogpy/", "platform": "", "project_url": "https://pypi.org/project/pybacklogpy/", "project_urls": { "Homepage": "https://kitadakyou.github.io/PyBacklogPy/" }, "release_url": "https://pypi.org/project/pybacklogpy/0.10/", "requires_dist": [ "requests (==2.22.0)" ], "requires_python": ">=3.5", "summary": "A library for backlog api", "version": "0.10" }, "last_serial": 5540316, "releases": { "0.10": [ { "comment_text": "", "digests": { "md5": "0a67a2e0c89cf3854de66fdbf34fc662", "sha256": "230d7c26e903262f35e732284d11e748e2ca065635721ab5f36ea402cdcb40eb" }, "downloads": -1, "filename": "pybacklogpy-0.10-py3-none-any.whl", "has_sig": false, "md5_digest": "0a67a2e0c89cf3854de66fdbf34fc662", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 41734, "upload_time": "2019-07-16T12:35:33", "url": "https://files.pythonhosted.org/packages/45/c9/48aad3e4b4a1fecb9584e95d0257409fd913d3a5a339950cabfddcce6dd1/pybacklogpy-0.10-py3-none-any.whl" } ], "0.8": [ { "comment_text": "", "digests": { "md5": "a89e73433628acd45d60350cf83e87ba", "sha256": "29462be739d9c0771a7ac17e5e382dbf1bb6b43ba6e41e47d42685f58392496a" }, "downloads": -1, "filename": "pybacklogpy-0.8-py3.7.egg", "has_sig": false, "md5_digest": "a89e73433628acd45d60350cf83e87ba", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": ">=3.5", "size": 3375, "upload_time": "2019-07-05T11:40:57", "url": "https://files.pythonhosted.org/packages/65/87/d9642a615c141d7b0da5648d522f7670efad55c0478d858857d27602699b/pybacklogpy-0.8-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "1ec66dcd4f0c443fbc36cef23d043352", "sha256": "ac266b59e14c756656a7dab16d4cb11547ea58570e503968853283167cb35fa2" }, "downloads": -1, "filename": "pybacklogpy-0.8-py3-none-any.whl", "has_sig": false, "md5_digest": "1ec66dcd4f0c443fbc36cef23d043352", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 39812, "upload_time": "2019-07-05T11:40:55", "url": "https://files.pythonhosted.org/packages/0f/bc/2ddbaad69a258070a6c89373abf39fd7a2fd88e34f811a0c71b830dc16a6/pybacklogpy-0.8-py3-none-any.whl" } ], "0.9": [ { "comment_text": "", "digests": { "md5": "938813dc0a4e366b76a312617459bf81", "sha256": "d3899256afbfdd4446ac0c160c09040cea8bf9f9727c4a52955ed3f0dfc613ff" }, "downloads": -1, "filename": "pybacklogpy-0.9-py3-none-any.whl", "has_sig": false, "md5_digest": "938813dc0a4e366b76a312617459bf81", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 39596, "upload_time": "2019-07-08T04:14:35", "url": "https://files.pythonhosted.org/packages/43/55/b86dd052c437a15566f9b0d1281a83efd45e4266571f959c878d3746db13/pybacklogpy-0.9-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0a67a2e0c89cf3854de66fdbf34fc662", "sha256": "230d7c26e903262f35e732284d11e748e2ca065635721ab5f36ea402cdcb40eb" }, "downloads": -1, "filename": "pybacklogpy-0.10-py3-none-any.whl", "has_sig": false, "md5_digest": "0a67a2e0c89cf3854de66fdbf34fc662", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 41734, "upload_time": "2019-07-16T12:35:33", "url": "https://files.pythonhosted.org/packages/45/c9/48aad3e4b4a1fecb9584e95d0257409fd913d3a5a339950cabfddcce6dd1/pybacklogpy-0.10-py3-none-any.whl" } ] }