BacklogPy

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

Release files for BacklogPy 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for BacklogPy 1.1.1
File	Size	Uploaded
BacklogPy-1.1.1.tar.gz	153.5 kB	Feb 5, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for BacklogPy 1.1.1
File	Interpreter	ABI	Platform	Reset
BacklogPy-1.1.1-py3-none-any.whl 28.5 kB Feb 5, 2022	Python 3	none	any	Details

Total release size: 182.0 kB

Release files / BacklogPy-1.1.1.tar.gz

Download URL	BacklogPy-1.1.1.tar.gz
Size	153.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`e5e32e737e6921d0468b8adf6c4065b3f74becc6669dd78f25bd76d2837a53d2`
BLAKE2b-256 checksum How to use checksums	`16ee1d558e49b7b1ae8254c1b63e27aed45684c739050838a7b3c142eaefa923`
Upload date	Feb 5, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10`

Release files / BacklogPy-1.1.1-py3-none-any.whl

Download URL	BacklogPy-1.1.1-py3-none-any.whl
Size	28.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`76a787729ba6e8805713a5ed2e129884552eb12dc4040493da313929f08fed02`
BLAKE2b-256 checksum How to use checksums	`b5a8cf4d3b2dced1e84f9f6a705a241c4879621e18a3c3b09c9e5af4e2b4ee7a`
Upload date	Feb 5, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10`