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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file caplena-3.0.0.tar.gz.
File metadata
- Download URL: caplena-3.0.0.tar.gz
- Upload date:
- Size: 51.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
python-requests/2.32.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
56706183a12882db482d4ae9cde6ce2cf9e0cdc3b26c9fa33a8635e9f8310d24
|
|
| MD5 |
06fb82ef6a93f808200d7aa03c500f63
|
|
| BLAKE2b-256 |
9bad7f55791bd2087959ba9f8c783183f3d2a37ae866f735509dee174e0275ac
|
File details
Details for the file caplena-3.0.0-py3-none-any.whl.
File metadata
- Download URL: caplena-3.0.0-py3-none-any.whl
- Upload date:
- Size: 37.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
python-requests/2.32.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
efd12d2df3399ae0a5abf264dfdb16bfcefcf4d880a6478ee281b9239626fca0
|
|
| MD5 |
ac8c2a1ce4ffa94e4c43d5caed3df66c
|
|
| BLAKE2b-256 |
15d43b61e7bab644b10cf7744226408c3dad9686ef3f49d537b88fd26ce3b3e5
|
