Skip to content

Latest commit

 

History

History
94 lines (58 loc) · 2.34 KB

README.rst

File metadata and controls

94 lines (58 loc) · 2.34 KB
Raw

pwclient

PyPi Status Documentation Status Build Status

pwclient is a VCS-agnostic tool for interacting with Patchwork, the web-based patch tracking system.

Installation

The easiest way to install pwclient and its dependencies is using pip. To do so, run:

$ python3 -m pip install pwclient

You can also install pwclient manually. First, install the required dependencies. On Fedora, run:

$ sudo dnf install python-pbr

On Ubuntu, run:

$ sudo apt-get install python-pbr

Once dependencies are installed, clone this repo and run setup.py:

$ git clone https://github.com/getpatchwork/pwclient
$ cd pwclient
$ python3 -m pip install --user .

Getting Started

To use pwclient, you will need a .pwclientrc file, located in your home directory ($HOME or ~). You can point to another path with the environment variable PWCLIENTRC. Patchwork itself provides sample .pwclientrc files for projects at /project/{projectName}/pwclientrc/. For example, here is the .pwclientrc file for Patchwork itself.

Development

If you're interested in contributing to pwclient, first clone the repo:

$ git clone https://github.com/getpatchwork/pwclient
$ cd pwclient

Create a virtualenv, then install the package in editable mode:

$ virtualenv .venv
$ source .venv/bin/activate
$ python3 -m pip install --editable .

Documentation

Documentation is available on Read the Docs