Usage¶
TrelloZilla requires you to provide configuration values for both Trello’s and Bugzilla’s API. The sample configuration file is well documented and self-explanatory about how you can produce the right values for it.
Generating configuration files¶
To generate sample configuration files:
$ mkdir -p ~/.trellozilla/trellozilla.conf.d
$ cd ~/.trellozilla/trellozilla.conf.d
$ oslo-config-generator --namespace trellozilla > trellozilla.conf
$ oslo-config-generator --namespace oslo.log > logging.conf
Check the oslo.config documentation to learn more about other places where you can place your configuration files.
The Trello configuration¶
The Trello configuration is composed of four values:
- api_key
- api_secret
- token
- token_secret
The first two ones you can find at https://trello.com/app-key.
Once you have setup your configuration file with your Trello api_key and api_secret you can use the following command to generate the token and token_secret:
$ generate_trello_oauth_token
The Bugzilla configuration¶
The Bugzilla configuration is composed of two values:
- url
- api_key
The buggzila api_key can be generated at:
your_bugzilla_url/userprefs.cgi?tab=apikey
Getting the API objects¶
To use TrelloZilla in a project:
import trellozilla
conf = trellozilla.get_config()
conf("trellozilla") # or `conf(project="my_project")` to help oslo.config finding your config file.
trello = trellozilla.trello_api(conf)
bugzilla = trellozilla.bugzilla_api(conf)
For following usage of both Trello and Bugzilla API objects, please refeer to py-trello and python-bugzilla projects.