/trello-cli

a CLI based trello client based on Typer, Pydantic, Rich, and Requests.

Primary LanguagePython

Trello CLI

Built with Typer, Pydantic, and Requests.

Typer is a framework built on Click, a popular CLI library for Python. It adds web framework style conventions and a clean, structured programming paradigm, leveraging decorator syntax to make CLI development more readily maintainable.

Pydantic brings type validation to Python, and helps to ensure objects are consistently marshalled. We use it in this case for env settings management as well.

Requests is a popular library for managing network requests and responses.

Documentation

Installing

It is recommended that you install the application using poetry and the included dist files:

poetry install

This will create an executable in your shell environment trello-cli If you prefer to run the app without installing, please use the following syntax: python -m trello_cli from the projects root directory.

For usage documentation on individual functions please refer to USAGE.md

API_KEY and API_TOKEN must be set through either env variables or a .env file in your execution directory. the format of the .env file is as follows:

api_key="xxxxxxxx"
api_token="xxxxxxxxx"

Tests may be run by ensuring the dev group dependencies are installed with: poetry install --with dev

Then run the test suite with: pytest tests/.

TODO

Next steps on this project would be to implement delete and update functionality for comments, archival and movement for cards, and to expand test coverage significantly.