caplena

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.8 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 all 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