Skip to main content

Git-Patchwork integration tool

Project description

PyPi Status Documentation Status Build Status

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-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 setup.py:

$ git clone https://github.com/getpatchwork/git-pw
$ cd git-pw
$ pip install --user .  # or 'sudo python setup.py'

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. This will typically look like. For example:

https://patchwork.ozlabs.org/
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/

You also require authentication - you can use either API tokens or a username/password combination:

pw.token

The API token for you Patchwork account.

pw.username

The username for your Patchwork account.

pw.password

The password for your Patchwork account.

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.0/'
$ 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-pw

Create 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

git-pw-1.1.1.tar.gz (16.8 kB view details)

Uploaded Source

Built Distribution

git_pw-1.1.1-py2.py3-none-any.whl (16.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file git-pw-1.1.1.tar.gz.

File metadata

  • Download URL: git-pw-1.1.1.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for git-pw-1.1.1.tar.gz
Algorithm Hash digest
SHA256 14eba1d86f411f0c6f8f6c6a61fb571c376a010ecff11adb3292db89f688a44e
MD5 09bd6c6b5b2353f6df0ed929bbb832f2
BLAKE2b-256 0aaafe7a4a26b1c8066b61ffb99d78fc7883602c606134e7d0594e760c49896a

See more details on using hashes here.

File details

Details for the file git_pw-1.1.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for git_pw-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 13f2dbde045697a16bcefc284ad5159760506af2657dab8c14e03e845972c9f1
MD5 79b84539a7674740ff63c7feebeceaad
BLAKE2b-256 fb4c902e5cefb7c2f9d68c1180b8a4b6e495d79785e93b61fe1e188e11a398d1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page