Völur SDK

This is the Python SDK for the Völur products and services.

Install

Go to the Installation page for more information.

How to use the library

See the documentation.

To see the examples of how to use the library, please refer to the examples folder.

Prerequisites

When developing this SDK, you choose between containerized and local development.

Pre-requisites for containerized development

• Earthly (docs).

Pre-requisites for local development

• Python (>=3.11, <3.12),
• just (docs),
• Poetry (docs),
• Poetry Upgrade Plugin (docs),
• buf (docs),

Reference guide

The Client SDK Reference Guide can be found in the interactive notebook client_SDK_reference_guide.ipynb. Here you'll find general usage information about the SDK.

To open the notebook, simply run

poetry run jupyter notebook

and select the reference guide notebook.

You'll need an authentication token to be able to run the notebook. Please contact us and a token will be issued to you.

Development

Configure

This command will install required Python dependencies:

just configure

or

earthly +configure

Formatting, linting, type checking and testing

We use a set of tools to improve the quality of our code:

• ruff as Python linter and code formatter,
• mypy for type checking

You can run these tools with just or Earthly.

Static validation

just validate

or

earthly +validate

Resolve auto-fixable issues

just fix

or

earthly +fix

Run tests

just test

or

earthly +test

Other useful commands

You can list all available recipes by running:

just

or

earthly ls

Documentation

We use google-style docstrings in our code. The documentation is generated using:

• https://github.com/mkdocstrings/python,
• https://github.com/squidfunk/mkdocs-material.

Generate documentation

We use the mkdocs-gen-files plugin to programmatically generate documentation pages during build.

To generate documentation, run:

just build-docs

or

earthly +build-docs

Serve documentation website

Warning

It is not possible to use container based development for documentation serving.

just serve-docs

And then open your browser using the provided link in the output.

Accessing documentation

Documentation is available at docs.volur.ai.