Skip to main content

A Python interface for Plankaban

Project description

plankapy

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

Getting Started

You can either clone this repository, or install with pip

Clone:

git clone https://github.com/hwelch-fle/plankapy.git

PIP:

pip install plankapy

PIP Page

After cloning the repo or installing the package, you can access the auto-docs generated by pdoc:

Documentation Link

Project Status

The goal of this project is to provide interfaces for as many Planka objects as possible.

Currently implemented routes include:

  • Project
  • Board
  • List
  • Card
  • Label
  • Background
  • User

Routes not yet implemented:

  • Attachment
  • Stopwatch
  • Comment

This project is currently being very slowly developed with me mostly just merging in patches from the community. When Planka 2.0 is made public, I will likely branch this repo off and work on re-developing it for some of the new features.

API Sources From Planka

Routes

Models

Helpers

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plankapy-1.0.1.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plankapy-1.0.1-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file plankapy-1.0.1.tar.gz.

File metadata

  • Download URL: plankapy-1.0.1.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for plankapy-1.0.1.tar.gz
Algorithm Hash digest
SHA256 00db01133e8dd3c05e3991bc4017dce5a166d249f6f27e779b731bd3fbd6aacd
MD5 cb06979449b326e7a650842793257366
BLAKE2b-256 33857c85babaeb4692c8f71a9b608d4959152b09948ef088116782111cc3f651

See more details on using hashes here.

File details

Details for the file plankapy-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: plankapy-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 20.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for plankapy-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5a7d28b4bcc934b646c4b454a5116855dd66d33193a9592eae1aff201690d362
MD5 c53a071b671bb120f3967125687ec41c
BLAKE2b-256 fa600fe409d8aa8b648e4baba59681456b3caee3feb965e3f18578e69fcba47a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page