cashctrl 0.0.12

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

According to the [principle of least privilegue](https://en.wikipedia.org/wiki/Principle_of_least_privilege it is recommended to create a seperate role for the admin user.

Then you can give it the exact permission it needs:

2. Create API-User

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

3. Add credentials 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 in a safe place

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 this library dynamically with the following command:

pip3 install -e /path/to/cashctrl-py

Now you can import it normally in other projects and changes in cashctrl-py get reflected immediately in all importing projects.

Swagger

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

IDE

The Project was developed in Vscode. You can install the recommended extensions when you first open the project:

Upload

1. increment version number
2. upload:

./upload.sh

Also see: Package Tutorial

.env

Make sure you don't put a .env file in the sources folder. It is dangerous because all projects that have importet cashctrl-py with pip -e will then use that file instead of their own...