https://github.com/pj-simpson/clidat
Inspect Codat JSON in the terminal!
https://github.com/pj-simpson/clidat
accounting api-client cli json tui
Last synced: 2 months ago
JSON representation
Inspect Codat JSON in the terminal!
- Host: GitHub
- URL: https://github.com/pj-simpson/clidat
- Owner: pj-simpson
- License: mit
- Created: 2023-03-02T10:45:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-27T14:52:34.000Z (about 3 years ago)
- Last Synced: 2025-04-09T18:59:49.305Z (about 1 year ago)
- Topics: accounting, api-client, cli, json, tui
- Language: Python
- Homepage: https://docs.codat.io/
- Size: 305 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CLIdat
CLIdat is a tool for inspecting Data from Codat.
The Command Line Interface itself is written with [Click](https://github.com/pallets/click),
whilst the output of the different commands is passed to
a TUI from the [Textual](https://github.com/Textualize/textual) package.
I work in support at Codat, and have built this tool as a personal project
to help with my day-job. This isn't an officially
supported product.
## Installation
CLIdat is distributed via the Python Package Index (PyPI). We reccomend installing
it inside a [virtual environment](https://docs.python.org/3/library/venv.html)
```console
(venv) user@host:~$ pip install clidat
```
Thanks to Textual, this software is cross-platform and
should work well on Windows, Linux and MacOS.
## Quick Start
```console
(venv) user@host:~$ clidat auth
Your Codat API Key:
(venv) user@host:~$ clidat get-suppliers -id 2e14de3b-e2cf-4745-af24-a9a082b4c466
```
## Docs
To see a list of all avaliable commands run:
```console
(venv) user@host:~$ run clidat --help
auth
get-account
get-account-transaction
get-account-transactions
...
```
To get details on a particular command, just append the --help
flag onto the end of the command, for example:
```console
(venv) user@host:~$ clidat get-payment --help
Options:
--payment TEXT [required]
-id, --company-id TEXT [required]
-j, --json View plain JSON response
--help Show this message and exit.
```