plankapy/README.md
Kumi c436377669
All checks were successful
website / build (push) Successful in 1m9s
feat(plankapy): add installation and usage guidelines
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.
2024-04-26 12:04:41 +02:00

1,020 B

plankapy

A python 3 based API for controlling a self-hosted Planka instance

This is a fork of the original plankapy project by hwelch-fle that primarily focuses on making the project a pip installable package.

Original Docs

Installation

pip install git+https://git.private.coffee/PrivateCoffee/plankapy.git

Usage

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 for more information.

Rest API Source

Routes

https://github.com/plankanban/planka/blob/master/server/config/routes.js

Models

https://github.com/plankanban/planka/tree/master/server/api/models

Helpers

https://github.com/plankanban/planka/tree/master/server/api/helpers