cashctrl 0.0.5

CashCtrl API Client

cashctrl

Unofficial python client for the cashctrl api v1

The goal was to make it easy, easier, easiest :smile::

import cashctrl
cc=cashctrl.Client()
people=cc.person.list()

Quickstart

1. Create role

It is recommended to create a seperate role for the admin user according to the principle of least privilegue.

2. Create API-User

Now we can create the api user and copy the api-key:

3. Add details to your environment

Create the .env file and add your api-key, organization and language:

cp .env.example .env && open .env

Make sure your .env file is safe

4. have fun

from cashctrl_py import CashCtrlClient
from icecream import ic

cc = CashCtrlClient()
people = cc.person.list()
ic(people)

Contribute

Submit a Pull Request

There is still much work to do 😔 If you want to contribute, please fork the repository and create a pull request. gh repo fork <USER>/cashctrl-py

Dynamic install

For development you can install the library dynamically with the following command:

pip3 install -e .

Now you can install it normally in other projects but the changes get reflected immediately.

Swagger

There is an unofficial swagger.json file to help with development. You can export it into your http-client i.e. insomnia.

IDE

I used Vscode. You can install the recommended extensions when you first open the project:

Upload

1. increment version number
2. upload:

./upload.sh