Metadata-Version: 2.1
Name: sindri
Version: 0.1.0a31
Summary: Sindri Python SDK
Home-page: https://sindri.app
License: MIT
Author: Sindri Labs
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: requests (>=2.13.0,<3.0.0)
Project-URL: Repository, https://github.com/Sindri-Labs/sindri-python
Description-Content-Type: text/markdown

# Sindri Python SDK

***This SDK is an alpha (testing) release and may change at any time.***

## Build Status

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/sindri-labs/sindri-python/build-publish-pypi.yml?style=for-the-badge)

## Description
The Sindri Python SDK.
Contains SDK code for Sindri APIs. Please see [sindri.app](https://sindri.app) for more details.

## Requirements
This SDK is compatible with Python `>=3.8`.
However, Sindri does not officially support usage with Python versions that have passed their [End of Life](https://devguide.python.org/versions/) support.

## Installation
You can install `sindri` from [PyPI](https://pypi.org/project/sindri/).
For example: `pip install sindri`

## Documentation and Usage
Documentation for this repo is automatically generated from the Python docstrings using [lazydocs](https://pypi.org/project/lazydocs/) and published to [sindri.app/docs/reference/sdk/](https://sindri.app/docs/reference/sdk/python) along with the rest of the documentation for Sindri.
Docstrings for functions and methods follow the [google standard](https://google.github.io/styleguide/pyguide.html#383-functions-and-methods) for formatting.

## License
[![](https://img.shields.io/github/license/sindri-labs/sindri-python?style=for-the-badge)](https://img.shields.io/github/license/sindri-labs/sindri-python?style=for-the-badge)

`sindri-python` is licensed under a [MIT License](LICENSE) and is copyright [Sindri Labs, Inc.](https://sindri.app).

## Unit Tests
See [`tests/README.md`](tests/README.md) for more information.
