Metadata-Version: 2.1
Name: PyPatchwork
Version: 0.1.1
Summary: A Python library to access the Patchwork REST API.
Home-page: https://github.com/tedd-an/PyPatchwork
Author: Tedd Ho-Jeong An
Author-email: hj.tedd.an@gmail.com
License: GPL version 3
Project-URL: Documentation, https://pypatchwork.readthedocs.io/en/latest/index.html
Project-URL: Source, https://github.com/tedd-an/PyPatchwork
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development
Classifier: Topic :: Communications :: Email :: Mailing List Servers
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# PyPatchwork
PyPatchwork is a Python library to access the [Patchwork](http://jk.ozlabs.org/projects/patchwork/) REST API.

## Installation
This package can be installed from [Python Package Index(PyPi)](https://pypi.org/project/PyPatchwork/).

```bash
$ pip install PyPatchwork
```

## Usage

```python
from patchwork import Patchwork

# Create patchwork object
pw = Patchwork('https://patchwork.kernel.org')

# Create patchwork object with access token
pw = Patchwork('https://patchwork.kernel.org', 'your_access_token')
```

## Examples

```python
from patchwork import Patchwork

pw = Patchwork('https://patchwork.kernel.org')

# Search project
projects = pw.get_all_projects()
for project in projects:
    if project.name == "Bluetooth":
        break

# Get Project
project = pw.get_project(395)

# Get Series
series = pw.get_series(565705)

```

## Class references

See [Patchwork Classes](https://pypatchwork.readthedocs.io/en/latest/classes.html) for the details of class

## Note

* Only support the basic GET method
* Need to improve the Pagination such as slice and get page
* Need to support query parameters
* Need to support more methods like PUT, and PATCH
* more to come
