# pbl
A Python package wraps Backlog API V2
## Usage
Install
```bash
pip install python-backlog
```
Code snippet
```python
import base64
import json
from backlog.base import BacklogAPI
def main():
"""
Initialize API Object
"""
api = BacklogAPI("your-space", "your-api-key")
"""
Project API
"""
# list project users
# https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-project-list/
print("# list project users")
users = api.project.list_users("SampleProject")
print(json.dumps(users, indent=2))
"""
Wiki API
"""
# list wikis
# https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-wiki-page-list/
print("# list wikis")
wikis = api.wiki.list("SampleProject")
print(json.dumps(wikis[0], indent=2))
# get attachment
# https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-issue-attachment/
print("# get attachment")
wiki = [w for w in api.wiki.list("SampleProject") if len(w["attachments"]) > 0][0]
attachment = api.wiki.get_attachment(
wikiId=wiki["id"],
attachmentId=wiki["attachments"][0]["id"])
attachment["data"] = base64.b64encode(attachment["data"]).decode()
print(json.dumps(attachment, indent=2))
if __name__ == "__main__":
main()
```
## See also
Qiita https://qiita.com/hassaku_63/items/b9eb2a1c7ecd3c19507d
## Contact
Twitter: [hassaku_63](https://twitter.com/hassaku_63)
Raw data
{
"_id": null,
"home_page": "https://github.com/hassaku63/pbl",
"name": "python-backlog",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "nulab backlog",
"author": "hassaku63",
"author_email": "hassaku63@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b4/c8/5dccb13b4af2ad36f63b3720b781eb70cc6f6c1450505ace96dc4dbc78fc/python-backlog-0.6.0.tar.gz",
"platform": null,
"description": "# pbl\n\nA Python package wraps Backlog API V2\n\n## Usage\n\nInstall\n\n```bash\npip install python-backlog\n```\n\nCode snippet\n\n```python\nimport base64\nimport json\nfrom backlog.base import BacklogAPI\n\n\ndef main():\n \"\"\"\n Initialize API Object\n \"\"\"\n api = BacklogAPI(\"your-space\", \"your-api-key\")\n\n \"\"\"\n Project API\n \"\"\"\n # list project users\n # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-project-list/\n print(\"# list project users\")\n users = api.project.list_users(\"SampleProject\")\n print(json.dumps(users, indent=2))\n\n\n \"\"\"\n Wiki API\n \"\"\"\n # list wikis\n # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-wiki-page-list/\n print(\"# list wikis\")\n wikis = api.wiki.list(\"SampleProject\")\n print(json.dumps(wikis[0], indent=2))\n\n # get attachment\n # https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-issue-attachment/\n print(\"# get attachment\")\n wiki = [w for w in api.wiki.list(\"SampleProject\") if len(w[\"attachments\"]) > 0][0]\n attachment = api.wiki.get_attachment(\n wikiId=wiki[\"id\"],\n attachmentId=wiki[\"attachments\"][0][\"id\"])\n attachment[\"data\"] = base64.b64encode(attachment[\"data\"]).decode()\n print(json.dumps(attachment, indent=2))\n\n\nif __name__ == \"__main__\":\n main()\n```\n\n## See also\n\nQiita https://qiita.com/hassaku_63/items/b9eb2a1c7ecd3c19507d\n\n## Contact\n\nTwitter: [hassaku_63](https://twitter.com/hassaku_63)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Backlog API v2 wrapper",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/hassaku63/pbl",
"Source": "https://github.com/hassaku63/pbl"
},
"split_keywords": [
"nulab",
"backlog"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ab82b39722a5f42258df8e0fc65f80667b03545e268d849933cab23231b5d22",
"md5": "569f4ea1afe51ec0c378bc04168dd990",
"sha256": "ce045547e5b88e417227663f3ca0b3a3bedd312bf49cfaf2a3bbdd964557ada8"
},
"downloads": -1,
"filename": "python_backlog-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "569f4ea1afe51ec0c378bc04168dd990",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11375,
"upload_time": "2023-09-03T09:06:27",
"upload_time_iso_8601": "2023-09-03T09:06:27.199944Z",
"url": "https://files.pythonhosted.org/packages/4a/b8/2b39722a5f42258df8e0fc65f80667b03545e268d849933cab23231b5d22/python_backlog-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b4c85dccb13b4af2ad36f63b3720b781eb70cc6f6c1450505ace96dc4dbc78fc",
"md5": "bf64b93418336ee77846c8d9b73b1bc3",
"sha256": "943fd61fd85fdddaeb8e1e5989cc9e9cdc4b02d943a3c40e7252716eef4c2ebd"
},
"downloads": -1,
"filename": "python-backlog-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "bf64b93418336ee77846c8d9b73b1bc3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9333,
"upload_time": "2023-09-03T09:06:29",
"upload_time_iso_8601": "2023-09-03T09:06:29.003467Z",
"url": "https://files.pythonhosted.org/packages/b4/c8/5dccb13b4af2ad36f63b3720b781eb70cc6f6c1450505ace96dc4dbc78fc/python-backlog-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-03 09:06:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hassaku63",
"github_project": "pbl",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"requirements": [
{
"name": "requests",
"specs": [
[
"~=",
"2.31.0"
]
]
}
],
"tox": true,
"lcname": "python-backlog"
}
JSON
