diff --git a/README.md b/README.md index 489d7fb..da6f16e 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,44 @@ # plankapy + A python 3 based API for controlling a self-hosted Planka instance This is a fork of the original [plankapy](https://github.com/hwelch-fle/plankapy) project by [hwelch-fle](https://github.com/hwelch-fle) that primarily focuses on making the project a pip installable package. -[Docs](https://hwelch-fle.github.io/plankapy/plankapy.html) +[Original Docs](https://hwelch-fle.github.io/plankapy/plankapy.html) -# Rest API Source +## Installation + +```bash +pip install git+https://git.private.coffee/PrivateCoffee/plankapy.git +``` + +## Usage + +```python +from plankapy import Planka, User + +planka = Planka('http://localhost:3000', 'username', 'password') +users = User(planka) + +for user in users.get(): + print(user) +``` + +Refer to the [original docs](https://hwelch-fle.github.io/plankapy/plankapy.html) +for more information. + +## Rest API Source + +### Routes -## Routes https://github.com/plankanban/planka/blob/master/server/config/routes.js -## Models +### Models + https://github.com/plankanban/planka/tree/master/server/api/models -## Helpers +### Helpers + https://github.com/plankanban/planka/tree/master/server/api/helpers diff --git a/pyproject.toml b/pyproject.toml index 46bf409..9c29809 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ authors = [ description = "A python 3 based API for controlling a self-hosted Planka instance" readme = "README.md" license = { file="LICENSE" } -requires-python = ">=3.10" +requires-python = ">=3.8" classifiers = [ "Programming Language :: Python :: 3", "License :: OSI Approved :: GNU Affero General Public License v3",