{"id":15009893,"url":"https://github.com/koxudaxi/backlogpy","last_synced_at":"2025-04-09T17:52:19.336Z","repository":{"id":22025933,"uuid":"94786327","full_name":"koxudaxi/BacklogPy","owner":"koxudaxi","description":"Backlog API v2 Client Library for Python","archived":false,"fork":false,"pushed_at":"2024-05-31T01:42:49.000Z","size":360,"stargazers_count":8,"open_issues_count":4,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-23T19:51:31.829Z","etag":null,"topics":["api","backlog","client","client-library","python","python2","python3"],"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/koxudaxi.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["koxudaxi"]}},"created_at":"2017-06-19T14:34:33.000Z","updated_at":"2023-12-07T07:52:56.000Z","dependencies_parsed_at":"2024-01-26T16:50:49.179Z","dependency_job_id":"08ca8669-9c9e-4ca0-b405-7fac1bd8c4c4","html_url":"https://github.com/koxudaxi/BacklogPy","commit_stats":{"total_commits":117,"total_committers":4,"mean_commits":29.25,"dds":0.5555555555555556,"last_synced_commit":"428b4904f14bb6e5ffd7e4b85304b3a9a56d016b"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2FBacklogPy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2FBacklogPy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2FBacklogPy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koxudaxi%2FBacklogPy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koxudaxi","download_url":"https://codeload.github.com/koxudaxi/BacklogPy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248083282,"owners_count":21045071,"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":["api","backlog","client","client-library","python","python2","python3"],"created_at":"2024-09-24T19:29:02.791Z","updated_at":"2025-04-09T17:52:19.314Z","avatar_url":"https://github.com/koxudaxi.png","language":"Python","funding_links":["https://github.com/sponsors/koxudaxi"],"categories":[],"sub_categories":[],"readme":"====================================================\nBacklogPy - Backlog API v2 Client Library for Python\n====================================================\n\n\n|Build Status| |Version| |Downloads| |Python Version|\n\n\nBacklogPy is `Backlog API v2 \u003chttps://developer.nulab-inc.com/docs/backlog/\u003e`_ Client Library for Python 2/3\n\n\n.. |Build Status| image:: http://img.shields.io/travis/koxudaxi/BacklogPy/master.svg?style=flat\n    :target: https://travis-ci.org/koxudaxi/BacklogPy\n    :alt: Build Status\n.. |Version| image:: http://img.shields.io/pypi/v/BacklogPy.svg?style=flat\n    :target: https://pypi.python.org/pypi/BacklogPy/\n    :alt: Version\n.. |Downloads| image:: https://pepy.tech/badge/backlogpy/month\n    :target: https://pepy.tech/project/backlogpy\n    :alt: Downloads\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/BacklogPy\n    :target: https://pypi.python.org/pypi/BacklogPy\n    :alt: Python Version\n\nInstall\n-------\nYou can install the client library with pip:\n\n.. code-block:: sh\n\n    $ pip install BacklogPy\n\nExample\n-------\nThe client Library has API Call methods for All Backlog v2 API:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e from BacklogPy import Backlog\n    \u003e\u003e\u003e backlog = Backlog('space_name','api-key')\n    \u003e\u003e\u003e response = backlog.get_project_list(all=True, archived=True)\n    \u003e\u003e\u003e print(response.json()[0])\n       {'archived': False,\n        'chartEnabled': True,\n        'displayOrder': 1234563786,\n        'id': 12345,\n        'name': 'Coffee Project',\n        'projectKey': 'COFFEE_PROJECT',\n        'projectLeaderCanEditProjectLeader': True,\n        'subtaskingEnabled': False,\n        'textFormattingRule': 'markdown',\n        'useWikiTreeView': True}\n\n\n\nAlso you can use dict parameters with '\\*_raw' methods:\n\n.. code-block:: python\n\n    \u003e\u003e\u003e response = backlog.get_project_list_raw({'archived':'false', 'all':'false'})\n\n\nScreenShot\n----------\n\nYou can use auto-completion for methods and arguments in Interpreter(IPython) and IDE(PyCharm, Jedi and more)\n\n.. image:: https://raw.githubusercontent.com/koxudaxi/BacklogPy/master/docs/img/auto-completion_arguments.png\n.. image:: https://raw.githubusercontent.com/koxudaxi/BacklogPy/master/docs/img/auto-completion_method.png\n\n\nDevelopment\n-----------\n\nTests\n~~~~~\n``tox`` can support to test with few python versions\n\n.. code-block:: sh\n\n    $ tox\n    $ tox -e py26,py36\n\nor ``nosetests`` for one Python version\n\n.. code-block:: sh\n\n    $ nosetests tests/backlog\n\nGenerating The Backlog API v2 Client\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nThe Backlog API v2 Client is created by api_generator.\napi_generator downloads API Documents from https://developer.nulab-inc.com/docs/backlog/ .\nAnd parse API Documents to generate The Backlog API v2 Client:\n\n.. code-block:: sh\n\n    $ python3 api_generator/api_generator.py download\n    $ python3 api_generator/api_generator.py create\n\nBuild Wheel Package\n~~~~~~~~~~~~~~~~~~~\n\n.. code-block:: sh\n\n    $ pip3 install wheel\n    $ python3 setup.py bdist_wheel\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoxudaxi%2Fbacklogpy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoxudaxi%2Fbacklogpy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoxudaxi%2Fbacklogpy/lists"}