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 install'

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.1

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.

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 your 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.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-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.7.0.tar.gz (31.9 kB view details)

Uploaded Source

Built Distribution

git_pw-1.7.0-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: git-pw-1.7.0.tar.gz
  • Upload date:
  • Size: 31.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for git-pw-1.7.0.tar.gz
Algorithm Hash digest
SHA256 fee56889f55315137ceeb80956534c974f596d91c43934531843f3aa88ee5ffc
MD5 b9315e53c44d3f1506c34049f762ddf1
BLAKE2b-256 751929be83969463c2c126fd5725a87e05ab1866580ba4fd5e1982d957ec79d8

See more details on using hashes here.

File details

Details for the file git_pw-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: git_pw-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for git_pw-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 28e3004a08cc9b50f03a37fcc2b928ed712a7c6db6dfb1e8c02e357f9e1b1ebe
MD5 a5d1fe72d84f8d81533ccf4978e52a39
BLAKE2b-256 bc026b8cb2764edb8129c4ed5b62f07586f6b54994aa288fed4ad183c832e066

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