Skip to main content

Backlog API v2 Client Library

Project description

Build Status Version Downloads Python Version

BacklogPy is Backlog API v2 Client Library for Python 2/3


You can install the client library with pip:

$ pip install BacklogPy


The client Library has API Call methods for All Backlog v2 API:

>>> from BacklogPy import Backlog
>>> backlog = Backlog('space_name','api-key')
>>> response = backlog.get_project_list(all=True, archived=True)
>>> print(response.json()[0])
   {'archived': False,
    'chartEnabled': True,
    'displayOrder': 1234563786,
    'id': 12345,
    'name': 'Coffee Project',
    'projectKey': 'COFFEE_PROJECT',
    'projectLeaderCanEditProjectLeader': True,
    'subtaskingEnabled': False,
    'textFormattingRule': 'markdown',
    'useWikiTreeView': True}

Also you can use dict parameters with ‘*_raw’ methods:

>>> response = backlog.get_project_list_raw({'archived':'false', 'all':'false'})


You can use auto-completion for methods and arguments in Interpreter(IPython) and IDE(PyCharm, Jedi and more)



tox can support to test with few python versions

$ tox
$ tox -e py26,py36

or nosetests for one Python version

$ nosetests tests/backlog

Generating The Backlog API v2 Client

The Backlog API v2 Client is created by api_generator. api_generator downloads API Documents from . And parse API Documents to generate The Backlog API v2 Client:

$ python3 api_generator/ download
$ python3 api_generator/ create

Build Wheel Package

$ pip3 install wheel
$ python3 bdist_wheel

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

BacklogPy-1.1.1.tar.gz (153.5 kB view hashes)

Uploaded source

Built Distribution

BacklogPy-1.1.1-py3-none-any.whl (28.5 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page