Git-Patchwork integration tool
Project description
git-pw is a tool for integrating Git with Patchwork, the web-based patch tracking system.
Installation
The easiest way to install git-pw and its dependencies is using pip. To do so, run:
$ pip install git-pwYou can also install git-pw manually. First, install the required dependencies. On Fedora, run:
$ sudo dnf install python3-requests python3-click python3-pbr \
python3-arrow python3-tabulate python3-yamlOn Ubuntu, run:
$ sudo apt-get install python3-requests python3-click python3-pbr \
python3-arrow python3-tabulate python3-yamlOnce dependencies are installed, clone this repo and install with pip:
$ git clone https://github.com/getpatchwork/git-pw
$ cd git-pw
$ pip install --user .Getting Started
To begin, you’ll need to configure Git settings appropriately. The following settings are required:
- pw.server
The URL for the Patchwork instance’s API. This should include the API version:
https://patchwork.ozlabs.org/api/1.3
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 3.2.x, you should use API version 1.3.
- pw.project
The project name or list-id. This will appear in the URL when using the web UI:
https://patchwork.ozlabs.org/project/{project_name}/list/
For read-write access, you also need authentication - you can use either API tokens or a username/password combination:
- pw.token
The API token for your Patchwork account.
- pw.username
The username for your Patchwork account.
- pw.password
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:
- pw.states
The states that can be applied to a patch using the git pw patch update command. Should be provided in slug form (changes-requested instead of 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'Development
If you’re interested in contributing to git-pw, first clone the repo:
$ git clone https://github.com/getpatchwork/git-pw
$ cd git-pwCreate a virtualenv, then install the package in editable mode:
$ virtualenv .venv
$ source .venv/bin/activate
$ pip install --editable .Documentation
Documentation is available on Read the Docs
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
