Metadata-Version: 2.4
Name: sdb-connector
Version: 1.0.1
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: OS Independent
Classifier: Topic :: Database
Summary: A Python library written in Rust for SurrealDB connection and data preparation
Keywords: surrealdb,rust,pyo3,xlsx
Author-email: Fabian Lieb <fabian.lieb@peptech.de>
License: MIT
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Project-URL: Homepage, https://github.com/IT-peptech/sdb_connector
Project-URL: Issues, https://github.com/IT-peptech/sdb_connector/issues
Project-URL: Repository, https://github.com/IT-peptech/sdb_connector

# sdb_connector

Python package with Rust/PyO3 bindings for SurrealDB access and data preparation.

## Install

```bash
pip install sdb-connector
```

Import in Python:

```python
import sdb_connector
```

## Versioning

Version is taken from `Cargo.toml` (`[package].version`).

## Local Build

```bash
python -m pip install --upgrade maturin twine
maturin build --release --sdist --out dist
python -m twine check dist/*
```

## Publish Manually

### TestPyPI

```bash
export MATURIN_PYPI_TOKEN=<testpypi-token>
maturin publish --repository testpypi --username __token__ --password "$MATURIN_PYPI_TOKEN"
```

### PyPI

```bash
export MATURIN_PYPI_TOKEN=<pypi-token>
maturin publish --username __token__ --password "$MATURIN_PYPI_TOKEN"
```

## GitHub Actions Publish

A workflow is included at `.github/workflows/publish-pypi.yml`:

- `workflow_dispatch` -> publish to `testpypi` or `pypi`
- `release.published` -> publish to `pypi`

Recommended: configure Trusted Publishing in PyPI/TestPyPI for this repository.

