feat(plankapy): add installation and usage guidelines
All checks were successful
website / build (push) Successful in 1m9s

Revised the README.md to include comprehensive sections on installation and usage, providing a clear path for users to get started with plankapy. Additionally, updates were made to highlight the fork's aim of making plankapy pip installable and ensuring compatibility with a wider range of Python versions by adjusting the requires-python version from >=3.10 to >=3.8 in pyproject.toml. This expansion not only increases accessibility for developers using older Python versions but also aligns with our goal to make the project more inclusive and user-friendly.
This commit is contained in:
Kumi 2024-04-26 12:04:41 +02:00
parent 25a81c0a9d
commit c436377669
Signed by: kumi
GPG key ID: ECBCC9082395383F
2 changed files with 31 additions and 6 deletions

View file

@ -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

View file

@ -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",