Metadata-Version: 2.4
Name: splight-lib
Version: 5.23.0.dev2
Summary: Splight Python Library
Author-email: Splight Dev <dev@splight.com>
License-File: LICENSE.txt
Requires-Python: <=3.12,>=3.10
Requires-Dist: apscheduler==3.10.4
Requires-Dist: concurrent-log-handler==0.9.21
Requires-Dist: cryptography==44.0.1
Requires-Dist: email-validator<3.0.0,>=2.1.0.post1
Requires-Dist: furl==2.1.3
Requires-Dist: geojson-pydantic==1.0.1
Requires-Dist: hexbytes==0.2.2
Requires-Dist: httpx==0.28.1
Requires-Dist: jinja2==3.1.4
Requires-Dist: mergedeep==1.3.4
Requires-Dist: numpy==1.26.0
Requires-Dist: pandas==2.2.3
Requires-Dist: parameterized==0.8.1
Requires-Dist: pathspec==0.11.1
Requires-Dist: progressbar2==4.4.1
Requires-Dist: py7zr==0.20.8
Requires-Dist: pydantic-settings==2.0.3
Requires-Dist: pydantic==2.4.2
Requires-Dist: pytz==2025.2
Requires-Dist: pyyaml==6.0.1
Requires-Dist: requests>=2.26.0
Requires-Dist: retry==0.9.2
Requires-Dist: simplejson==3.17.6
Requires-Dist: strenum==0.4.9
Requires-Dist: typer==0.15.1
Requires-Dist: typing-extensions<5.0.0,>=4.6.1
Description-Content-Type: text/markdown

# Splight Python SDK

![snyk_code](https://github.com/splightplatform/splight-lib-python/blob/gh-pages/snyk_code.svg?raw=True)
![snyk_dependencies](https://github.com/splightplatform/splight-lib-python/blob/gh-pages/snyk_dependencies.svg?raw=True)

---

## Installation

A release version can be installed using `pip` with

```bash 
pip install --upgrade splight-lib
```

or if you want one particular version you can use
```bash 
pip install splight-lib==x.y.z
```

### For Development

This library uses `uv` as package manager. In order to install `uv` you can 
use the command
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

Then to insall the library you can use the command in development mode you 
can use

```bash
uv sync
```

and for running a python interpreter within the environment you can use

```bash
uv run python
```


#### Managing versions

The package is managed using `poetry` so we should use this tool for handling
versioning. In particular, the repository contains a `Makefile` that contains 
the commands for updating the splight-lib versions. So, if you need to update
the version you should use the command

```bash
make update-version scope=<scope>
```
where scope can be `major`, `minor` or `patch`.

## Tests

```
make test
```
