Caplena Python Library
The Caplena Python library provides convenient access to the Caplena REST API from applications written in the Python programming language.
Documentation
To learn more about what you can use Caplena for and for how to create your own API key, please see our main website.
To learn more about the REST API that constitutes the basis for this project, take a look at our REST API docs.
To view the Python API docs and refernces, head over to our SDK documentation.
Installation
Minimum Version
We recommend using the latest version of Python. Caplena supports Python 3.10 and newer.
Dependencies
The following distributions will be installed automatically when installing Caplena.
- Requests is an elegant and simple HTTP library for Python.
- Typing Extensions enables use of new type system features on older Python versions.
Installing Caplena
Within your Python environment of choice, use the following command to install Caplena:
$ pip install caplena
Caplena is now installed.
Development
To use caplena-python in a development environment, we recommend you to set up a development virtualenv. Once done, you
can run the following command to install all required dependencies:
make install
Run all tests:
make test
Run live API integration tests (requires a Caplena API at http://localhost:8000):
make test-integration
Run unit tests in watch mode:
make test-watch
Run the formatter:
make fmt
Run the linter:
make lint
Build the Sphinx SDK docs:
make build-docs
The Sphinx generated documentation is automatically generated and uploaded to our developer documentation portal, using Github Actions.
Build the Python package:
make build-sdk
Publish the Python package:
make publish-sdk
Show all supported commands:
make help
1 maintainer
Metadata
1 maintainer
Release files for caplena 4.0.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 | |
|---|---|---|---|---|
| caplena-4.0.0.tar.gz | 30.2 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| caplena-4.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 68.4 kB
Release files / caplena-4.0.0.tar.gz
| Download URL | caplena-4.0.0.tar.gz |
|---|---|
| Size | 30.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f32511e30595943bb2d0a51193b6a7870b13ade844cd8ba2a97e5b0ba9f463a
|
|
BLAKE2b-256 checksum How to use checksums |
0aa062987eaedcd37766388f3a52d7187aad33cefe20bf43012b05bd519a6c3e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.31.0
|
Release files / caplena-4.0.0-py3-none-any.whl
| Download URL | caplena-4.0.0-py3-none-any.whl |
|---|---|
| Size | 38.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ef2dbd684910e0ec4cdd7c8f71633a4541d04c1839ecd54db9fe222a98647481
|
|
BLAKE2b-256 checksum How to use checksums |
ccca9b49b78074db8159f44a2cbb27fa55b40d113c85c360d24baacc7e215982
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.31.0
|
Security for caplena 4.0.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.
