https://github.com/getpatchwork/pwclient
The command-line client for the patchwork patch tracking tool
https://github.com/getpatchwork/pwclient
Last synced: 6 months ago
JSON representation
The command-line client for the patchwork patch tracking tool
- Host: GitHub
- URL: https://github.com/getpatchwork/pwclient
- Owner: getpatchwork
- License: gpl-2.0
- Created: 2018-10-21T10:22:47.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-01-08T16:05:04.000Z (over 1 year ago)
- Last Synced: 2025-04-14T12:55:54.575Z (about 1 year ago)
- Language: Python
- Size: 261 KB
- Stars: 53
- Watchers: 7
- Forks: 22
- Open Issues: 9
-
Metadata Files:
- Readme: README.rst
- License: COPYING
Awesome Lists containing this project
README
========
pwclient
========
.. NOTE: If editing this, be sure to update the line numbers in 'doc/index'
.. image:: https://badge.fury.io/py/pwclient.svg
:target: https://badge.fury.io/py/pwclient
:alt: PyPi Status
.. image:: https://readthedocs.org/projects/pwclient/badge/?version=latest
:target: https://pwclient.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://github.com/getpatchwork/pwclient/actions/workflows/ci.yaml/badge.svg
:target: https://github.com/getpatchwork/pwclient/actions/workflows/ci.yaml
:alt: Build Status
*pwclient* is a VCS-agnostic tool for interacting with `Patchwork`__, the
web-based patch tracking system.
__ http://jk.ozlabs.org/projects/patchwork/
Installation
------------
The easiest way to install *pwclient* and its dependencies is using ``pip``. To
do so, run:
.. code-block:: bash
$ python3 -m pip install pwclient
You can also install *pwclient* manually. First, install the required
dependencies. On Fedora, run:
.. code-block:: bash
$ sudo dnf install python-pbr
On Ubuntu, run:
.. code-block:: bash
$ sudo apt-get install python-pbr
Once dependencies are installed, clone this repo and run ``setup.py``:
.. code-block:: bash
$ 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.
__ https://patchwork.ozlabs.org/project/patchwork/pwclientrc/
Development
-----------
If you're interested in contributing to *pwclient*, first clone the repo:
.. code-block:: bash
$ git clone https://github.com/getpatchwork/pwclient
$ cd pwclient
Create a *virtualenv*, then install the package in `editable`__ mode:
.. code-block:: bash
$ virtualenv .venv
$ source .venv/bin/activate
$ python3 -m pip install --editable .
__ https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs
Documentation
-------------
Documentation is available on `Read the Docs`__
__ https://pwclient.readthedocs.io/