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

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.0.tar.gz (21.1 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.0-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for plankapy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c74fff76c40db0d8cde2eb21b206883e7a42bb9b6a9ef535cd12aa330e45e6d3
MD5 95ab7df80b0d73392378e98fa15421e5
BLAKE2b-256 9d3f747bd851df2162c099e1cf45e8b4c2e66f315eb45267fa36e8a5687fca21

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for plankapy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e78dffc0e5b4c7ea89af3ce526d1b303f85e0a579c0984d9c4ecd83f1d07a306
MD5 f234e70c5eebc8aaf2423e06bf757b7c
BLAKE2b-256 ac65177d49153cfd7ab301aee555dba37064e93bc31b92211e2f75b6b5764dc9

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