Python API

[hwelch-fle]

I've thrown together a really rough python API for managing a Planka instance.

plankapy

It's not the cleanest implementation, but in my Planka use case I needed something that let me quickly build out and parse deck states for tracking purposes.

Will continue to update the repo with documentation over the coming weeks.

For now you can test it out by running the test_planka() function in the plankapy.py file. The controllers.py file is currently depreciated. The tests should build out a Project, Board, List, Cards, Tasks, Labels, Card Labels, Backgrounds, and update everything to show all the routes that have been implemented

[meltyshev]

Wow, great work! We'll definitely add a link to your repository to the documentation.

[hwelch-fle]

Thanks! If there's any functionality you think I should add or any dangerous practices you think I'm doing definitely let me know.

I tried to keep most of the configuration linked to the config files, but abandoned the config route file because it was getting a bit unwieldy. All the post data used by the controller build functions is defined in the template.json file so it'll be easier to update the data model in the future if any new models are added.

Each controller subclass uses the build function from the root Controller class, and overrides the get/create(post)/update(patch)/delete functions with the specific routing method needed.

Any models with routes that allow ID input can be set by ID directly using the oid variable, but otherwise you can use positional arguments in the form of Project Name -> Board Name -> List Name -> Card Name -> <Object> Name to get any object.

They all also require a Planka instance object which allows you to create multiple planka instances for different users and build controllers per user instance.

[daniel-hiller]

Hey, thanks for your work.
I have added this to the documentation