Skip to main content

Backlog API v2 Client Library

Project description

Build Status Version

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

Install

You can install the client library with pip:

$ pip install BacklogPy

Example

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'})

ScreenShot

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

https://raw.githubusercontent.com/koxudaxi/BacklogPy/master/docs/img/auto-completion_arguments.png https://raw.githubusercontent.com/koxudaxi/BacklogPy/master/docs/img/auto-completion_method.png

Development

Tests

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 https://developer.nulab-inc.com/docs/backlog/ . And parse API Documents to generate The Backlog API v2 Client:

$ python3 api_generator/api_generator.py download
$ python3 api_generator/api_generator.py create

Build Wheel Package

$ pip3 install wheel
$ python3 setup.py 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.

Filename, size & hash SHA256 hash help File type Python version Upload date
BacklogPy-1.0.4-py3-none-any.whl (42.1 kB) Copy SHA256 hash SHA256 Wheel py3
BacklogPy-1.0.4.tar.gz (14.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page