Any testing would be great! I tried to write it in a way where you can install it and basically let VS Code or your intelisense editor of choice do most of the work.

Go ahead and join the discussion on the repo and I'll let you know when I publish the first v2 package to PyPi. That way you can just pip install it and start using it.

The idea would be to publish a container that lets you run it alongside Planka to handle doing automation or batch operations in a few lines of Python.

ok thanks, I will do so..

I will create a public repository and post my work on mass importing boards/attachments from trello there. When I was working with your api, I noticed that there was no entry point for attachments, as I understand now this is due to the limitations of planka v1. As far as I understand, the development of planka v1 is stopped, as planka v2 is being prepared for release. We should probably ask the developer at this stage to implement functionality for working with attachments. Have you thought about getting involved in the development of the api in planka v2?

I've actually got it working now with their help. I'll version bump and make a new release soon!

I also tried to write plankapy in a way that will let me just implement their new API if they have one and extend the interfaces. All communication with the API is hidden from the end user, they just treat it like a reguar Python object.

That's great! Looking forward to updating your repository. Thank you for your work, it is much appreciated

That's great! Looking forward to updating your repository. Thank you for your work, it is much appreciated

As long as you're using 3.11+, you can pip install it. Latest version in 2.2.1 with minor version 2 being the added attachment functionality and the patch 1 being some last second updates to allow for managing user avatars and allowing webassets to be used instead of local filepaths.

for user in planka.users:
    user.set_avatar('http://<url-to-avatar>.png')

Would set all user avatars to some image on the web

for user in planka.users:
    user.download_avatar(f'/home/user/avatars/{user.name}_avatar.png')

Would download all user avatars to a local folder.

This also works with project backgrounds and attachments, though with attachments you'd want to use the stored filename so the filetype is captured correctly.

My next step will be re-writing some of the typing stuff to make it compatible with 3.8 at least. I went really aggressive with the new typing features to make IDE auto-completion and static checks work everywhere. That means you need 3.11 with the Self and Optional types currently, but I can just defer those imports depending on version. Other than that there are no dependencies and it all runs on the standard library.

Thank you dear friend. If you have indeed implemented attachment handling in your api, I will urgently start developing a python migration script using your api. However, I can't find the api documentation page, I used to have it in my bookmarks - https://hwelch-fle.github.io/plankapy/plankapy.html#Card.template. But now the response is 404 - Not Found.

Thank you dear friend. If you have indeed implemented attachment handling in your api, I will urgently start developing a python migration script using your api. However, I can't find the api documentation page, I used to have it in my bookmarks - https://hwelch-fle.github.io/plankapy/plankapy.html#Card.template. But now the response is 404 - Not Found.

I updated the docs with hardlinks instead of autorefs: https://hwelch-fle.github.io/plankapy/interfaces/Card/

You can also just click API in the title bar from the 404 page and it'll drop you on the API docs

I'm rebuilding the docs now, there was still a Danger tag in there saying Attachments weren't supported

Hey! Thanks for working on this ❤️

I tried generating the full SDK once using https://openapi-generator.tech, and it worked pretty well. The only issue I ran into was that uploading files required using dictionaries to pass the data instead of models. So yes, this would definitely be the best approach - to update it automatically based on the Swagger spec :)

Since this is built directly from your spec, I may be opening some minor PRs to keep that spec consistent and correct when I run into issues since my old approach of writing the API typing by hand was a pain and led to issues when new features were added.

Absolutely, feel free to open any PR - we'd be happy to merge it.

Would definitely appreciate feedback from the team here if you have any!

We'll definitely check it soon! Also, in the final v2, there will be the ability to generate API keys per user (already merged), which should make it easier to use plankapy.

I think having a fully type hinted API will be crazy useful. Especially if it's following the swagger spec exactly. There will of course be divergences from the api backend when implementing interfaces (the whole point of plankapy is to make Planka abide by Python object types and behaviors), but those are easier to deal with if the type system highlights them when the backend gets rebuilt.

Here's a quick example of the current working api portion (required attributes are marked as such so a type checker will yell at you if they aren't filled out):

All exposed attributes are typed and allow for easy navigation of the response dictionary. The models will inherit the direct response for each object to build type conversion in for the final public interface:

Omg, it looks very cool!

Very excited to get it completed, we're finally upgrading to v2 soon so I have the time to update the package.

Managed to get a minimal interface up and running today, just have to finish implementation and write the tests now!

Hey, congrats - you've done a great job!

Hey, congrats - you've done a great job!

Thanks! I've gone ahead and published a new release with the current code and made a PR on the docs repo with the updated README

Next big thing is setting up a docker container that runs a small webserver that accepts hooks from planka and runs automations.