git-pw (Patchwork subcommand for Git)¶
git-pw is a tool for integrating Git with Patchwork, the web-based patch tracking system.
git-pw only supports Patchwork 2.0+ and REST API support must be enabled
on the server end. You can check for support by browsing
/about for your
given instance. If this page returns a 404, you are using Patchwork < 2.0.
The pwclient utility can be used to interact with older Patchwork instances or instances with the REST API disabled.
The easiest way to install git-pw and its dependencies is using
do so, run:
$ pip install git-pw
You can also install git-pw manually. First, install the required dependencies. On Fedora, run:
$ sudo dnf install python-requests python-click python-pbr python-arrow \ python-tabulate
On Ubuntu, run:
$ sudo apt-get install python-requests python-click python-pbr python-arrow \ python-tabulate
Once dependencies are installed, clone this repo and run
$ git clone https://github.com/getpatchwork/git-pw $ cd git-pw $ pip install --user . # or 'sudo python setup.py install'
To begin, you’ll need to configure Git settings appropriately. The following settings are required:
The URL for the Patchwork instance’s API. This should include the API version:
You can discover the API version supported by your instance by comparing the server version, found at
/about, with the API versions provided in the documentation. For example, if your server is running Patchwork version 2.1.x, you should use API version 1.1.
The project name or list-id. This will appear in the URL when using the web UI:
For read-write access, you also need authentication - you can use either API tokens or a username/password combination:
- The API token for your Patchwork account.
- The username for your Patchwork account.
- The password for your Patchwork account.
If only read-only access is desired, credentials can be omitted.
The following settings are optional and may need to be set depending on your Patchwork instance’s configuration:
- The states that can be applied to a patch using the
git pw patch updatecommand. Should be provided in slug form (
Changes Requested). Only required if your Patchwork instance uses non-default states.
You can set these settings using the
git config command. This should be
done in the repo in which you intend to apply patches. For example, to
configure the Patchwork project, run:
$ git config pw.server 'https://patchwork.ozlabs.org/api/1.1/' $ git config pw.project 'patchwork'
If you’re interested in contributing to git-pw, first clone the repo:
$ git clone https://github.com/getpatchwork/git-pw $ cd git-pw
Create a virtualenv, then install the package in editable mode:
$ virtualenv .venv $ source .venv/bin/activate $ pip install --editable .