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’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.5.0.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

git_pw-1.5.0-py2.py3-none-any.whl (19.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: git-pw-1.5.0.tar.gz
  • Upload date:
  • Size: 28.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for git-pw-1.5.0.tar.gz
Algorithm Hash digest
SHA256 0defd1041641b419b868ecbdd2a74f93d5ab888e5b05a5d7c985eb8fa2f11e45
MD5 f2b8a26a89cf82b1e16b5bb7f86bd8cb
BLAKE2b-256 b39af08543d6303fd0db9f05b31d9dbd7598848c43488aece51d8cddaa5318a0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: git_pw-1.5.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 19.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for git_pw-1.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 dbf181d22ff8ab420c2217aea82a7b71e9a0dd5edd65d8bb2e829b515603dbe0
MD5 d4e02dbac703fafaefcd4a0a189df980
BLAKE2b-256 bed2e54fcc77cff8c556ab11a224f5f17c28f2adc485aa5c538c41dc74d7444f

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