Metadata-Version: 2.3
Name: corelibs-db
Version: 1.0.0
Summary: CoreLibs DB Interface
Author: Clemens Schwaighofer
Author-email: Clemens Schwaighofer <clemens.schwaighofer@omc.com>
Requires-Dist: corelibs-log>=1.0.0
Requires-Dist: corelibs-stack-trace>=1.0.1
Requires-Python: >=3.13
Description-Content-Type: text/markdown

# CoreLibs Python DB Interface

This is part of the Python CoreLibs

## Overview

Database Interface

## Install

```sh
uv add --index opj-pypi=https://git.egplusww.jp/api/packages/PyPI/pypi/simple/ corelibs-db
```

## Usage

See <DOCUMENTATION.md>

## Development

See <DEVELOPMENT.md> for detailed development information

### UV setup

uv must be [installed](https://docs.astral.sh/uv/getting-started/installation/)

### Python venv setup

After clone, run the command below to install all dependenciss

```sh
uv sync
```

### Build and Publish

```sh
uv build
uv publish --index opj-pypi --token <gitea token>
```

### Python tests

All python tests are the tests/ folder. They are structured by the source folder layout

run them with

```sh
uv run pytest
```

Get a coverate report

```sh
uv run pytest --cov=<project>
uv run pytest --cov=<project> --cov-report=term-missing
```

### Other tests

In the test-run folder usage and run tests are located, runt them below

```sh
uv run test-run/<script>
```
