kassalappy: Python Client for Kassal.app API
kassalappy is a Python client library designed to interact with the Kassalapp API, providing a convenient way to access its features programmatically. It also includes a command-line interface (CLI) for easy interaction with the API from the terminal.
Features
- Asynchronous design using
aiohttpfor non-blocking API calls. - Pydantic models for data validation and serialization.
- Custom exceptions for handling API errors.
- CLI with commands for health checks, managing shopping lists, searching products, and more.
- Tabulated output for CLI commands for better readability.
Installation
To install kassalappy, you can use pip:
pip install kassalappy
Usage
As a Library
To use kassalappy as a library, you need to create an instance of the Kassalapp class with your API access token:
from kassalappy import Kassalapp
client = Kassalapp(access_token='your_access_token_here')
You can then use the client to perform various operations, such as:
# Check API health
health_status = await client.healthy()
# Get shopping lists
shopping_lists = await client.get_shopping_lists()
# Search for products
products = await client.product_search(search='milk')
As a CLI
kassalappy also provides a CLI for interacting with the Kassalapp API. Here are some examples of CLI commands:
# Check API health
kassalappy health --token your_access_token_here
# Get shopping lists
kassalappy shopping-lists --token your_access_token_here
# Search for products
kassalappy product "milk" --token your_access_token_here
Documentation
For more detailed information about the API endpoints and data models, refer to the official Kassalapp API documentation: Kassal.app API Docs
Contributing
Contributions to kassalappy are welcome! Please follow the standard GitHub flow for submitting pull requests.
License
kassalappy is released under the MIT License. See the LICENSE file for more details.
This README provides a general overview of the kassalappy client. For specific details on the API methods and CLI commands, please refer to the source code and the official API documentation.
1 maintainer
Metadata
1 maintainer
Release files for kassalappy 1.2.0
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 | |
|---|---|---|---|---|
| kassalappy-1.2.0.tar.gz | 12.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kassalappy-1.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 25.5 kB
Release files / kassalappy-1.2.0.tar.gz
| Download URL | kassalappy-1.2.0.tar.gz |
|---|---|
| Size | 12.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7ac385b65b0305bb927aaef0a0a6c85b8c28509f5452a042f447169b4c45032a
|
|
BLAKE2b-256 checksum How to use checksums |
f79ff6249241c5803c446b5e5b9d5cdbdb61264ca2cf370d65e882cd68944fe9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.7
|
Release files / kassalappy-1.2.0-py3-none-any.whl
| Download URL | kassalappy-1.2.0-py3-none-any.whl |
|---|---|
| Size | 13.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0c91caecc767b51374806dfc791615ac22c8982d85a5813252166d7d1f93ee5e
|
|
BLAKE2b-256 checksum How to use checksums |
422cfb2a744b685785b5b6523a662aba7525150e6afc9640d25679bffd4869b1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.0 CPython/3.12.7
|
Security for kassalappy 1.2.0
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.
