========
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/
Raw data
{
"_id": null,
"home_page": "https://github.com/getpatchwork/pwclient",
"name": "pwclient",
"maintainer": "Stephen Finucane",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "stephen@that.guru",
"keywords": "patchwork api",
"author": "Nate Case",
"author_email": "ncase@xes-inc.com",
"download_url": "https://files.pythonhosted.org/packages/d2/f6/b3cbab3a96b0c7366d0ae50d85299d9f8c3099479fedf257174535e257c3/pwclient-2.8.0.tar.gz",
"platform": null,
"description": "========\npwclient\n========\n\n.. NOTE: If editing this, be sure to update the line numbers in 'doc/index'\n\n.. image:: https://badge.fury.io/py/pwclient.svg\n :target: https://badge.fury.io/py/pwclient\n :alt: PyPi Status\n\n.. image:: https://readthedocs.org/projects/pwclient/badge/?version=latest\n :target: https://pwclient.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://github.com/getpatchwork/pwclient/actions/workflows/ci.yaml/badge.svg\n :target: https://github.com/getpatchwork/pwclient/actions/workflows/ci.yaml\n :alt: Build Status\n\n*pwclient* is a VCS-agnostic tool for interacting with `Patchwork`__, the\nweb-based patch tracking system.\n\n__ http://jk.ozlabs.org/projects/patchwork/\n\n\nInstallation\n------------\n\nThe easiest way to install *pwclient* and its dependencies is using ``pip``. To\ndo so, run:\n\n.. code-block:: bash\n\n $ python3 -m pip install pwclient\n\nYou can also install *pwclient* manually. First, install the required\ndependencies. On Fedora, run:\n\n.. code-block:: bash\n\n $ sudo dnf install python-pbr\n\nOn Ubuntu, run:\n\n.. code-block:: bash\n\n $ sudo apt-get install python-pbr\n\nOnce dependencies are installed, clone this repo and run ``setup.py``:\n\n.. code-block:: bash\n\n $ git clone https://github.com/getpatchwork/pwclient\n $ cd pwclient\n $ python3 -m pip install --user .\n\nGetting Started\n---------------\n\nTo use *pwclient*, you will need a ``.pwclientrc`` file, located in your home\ndirectory (``$HOME`` or ``~``). You can point to another path with the\nenvironment variable ``PWCLIENTRC``. Patchwork itself provides sample\n``.pwclientrc`` files for projects at ``/project/{projectName}/pwclientrc/``.\nFor example, `here`__ is the ``.pwclientrc`` file for Patchwork itself.\n\n__ https://patchwork.ozlabs.org/project/patchwork/pwclientrc/\n\n\nDevelopment\n-----------\n\nIf you're interested in contributing to *pwclient*, first clone the repo:\n\n.. code-block:: bash\n\n $ git clone https://github.com/getpatchwork/pwclient\n $ cd pwclient\n\nCreate a *virtualenv*, then install the package in `editable`__ mode:\n\n.. code-block:: bash\n\n $ virtualenv .venv\n $ source .venv/bin/activate\n $ python3 -m pip install --editable .\n\n__ https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs\n\n\nDocumentation\n-------------\n\nDocumentation is available on `Read the Docs`__\n\n__ https://pwclient.readthedocs.io/\n",
"bugtrack_url": null,
"license": "GPL v2",
"summary": "The command-line client for the Patchwork patch tracking tool",
"version": "2.8.0",
"project_urls": {
"Bug Tracker": "https://github.com/getpatchwork/pwclient/issues",
"Documentation": "https://pwclient.readthedocs.io",
"Homepage": "https://github.com/getpatchwork/pwclient",
"Source Code": "https://github.com/getpatchwork/pwclient"
},
"split_keywords": [
"patchwork",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c666857af14914d103e46ca9f8cb74244ad9242ab035a5a3e6aaabda140e9626",
"md5": "72877c58f9b35518296ff3f58521d650",
"sha256": "2473c896db3adcce539d33ee840040966dbf21e7936f38b645633d083968ca5f"
},
"downloads": -1,
"filename": "pwclient-2.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72877c58f9b35518296ff3f58521d650",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 25803,
"upload_time": "2024-10-23T19:28:25",
"upload_time_iso_8601": "2024-10-23T19:28:25.236571Z",
"url": "https://files.pythonhosted.org/packages/c6/66/857af14914d103e46ca9f8cb74244ad9242ab035a5a3e6aaabda140e9626/pwclient-2.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d2f6b3cbab3a96b0c7366d0ae50d85299d9f8c3099479fedf257174535e257c3",
"md5": "e2e2ca6d3c4044c1c2be146c783a1cfe",
"sha256": "064c657e3926af96cb2eca808a1f1ce161679e025f327c22857de8a422d66bad"
},
"downloads": -1,
"filename": "pwclient-2.8.0.tar.gz",
"has_sig": false,
"md5_digest": "e2e2ca6d3c4044c1c2be146c783a1cfe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 41828,
"upload_time": "2024-10-23T19:28:26",
"upload_time_iso_8601": "2024-10-23T19:28:26.271948Z",
"url": "https://files.pythonhosted.org/packages/d2/f6/b3cbab3a96b0c7366d0ae50d85299d9f8c3099479fedf257174535e257c3/pwclient-2.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 19:28:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "getpatchwork",
"github_project": "pwclient",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pwclient"
}
JSON
