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
- increment version number
- 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...
1 maintainer
Metadata
1 maintainer
Release files for cashctrl 0.0.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cashctrl-0.0.14.tar.gz | 218.6 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cashctrl-0.0.14-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 232.7 kB
Release files / cashctrl-0.0.14.tar.gz
| Download URL | cashctrl-0.0.14.tar.gz |
|---|---|
| Size | 218.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bb1ce521680c0bf90c3cf177039398692c9f165c03af94078558c8909215c857
|
|
BLAKE2b-256 checksum How to use checksums |
e324196f48c926bf78a554d77af61443fb916ef61e4c38c5115a0fc5250341fb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Release files / cashctrl-0.0.14-py3-none-any.whl
| Download URL | cashctrl-0.0.14-py3-none-any.whl |
|---|---|
| Size | 14.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
95cb25e1938b5553f18af6f0ec78dae66b7b66be182e342f9689cf3a260a3e3c
|
|
BLAKE2b-256 checksum How to use checksums |
3f6b1812843930fed9b9e0bdf2107be4d421ba0dd1a3706a4ec83077e5b24c8f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.11
|
Security for cashctrl 0.0.14
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
