Metadata-Version: 2.1
Name: sdrdm_database
Version: 0.3.0
Summary: An sdRDM-based framework to utilize databases
License: MIT
Author: Jan Range
Author-email: 30547301+JR-1991@users.noreply.github.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: mysql
Provides-Extra: postgres
Requires-Dist: ibis-framework (>=7.0.0,<8.0.0)
Requires-Dist: pydantic (==1.10)
Description-Content-Type: text/markdown

# sdrdm-database

![Tests](https://github.com/JR-1991/sdrdm-database/actions/workflows/test.yml/badge.svg) ![Integration](https://github.com/JR-1991/sdrdm-database/actions/workflows/integration.yml/badge.svg)

This is the sdRDM DB interface to create tables from a markdown model and insert/retrieve data from it.

## Installation

To get started with the sdRDM DB interface, you can install it via pip:

```bash
# Base installation
pip install sdrdm_database

# MySQL
pip install "sdrdm_database[mysql]"

# PostgreSQL
pip install "sdrdm_database[postgres]"
```

or directly from the GitHub repository:

```bash
pip install git+https://github.com/JR-1991/sdrdm-database.git
```

## Examples

* [Setting up a MySQL database and add an EnzymeML model](./examples/mysql/)
* [Setting up a PostgreSQL database and add an EnzymeML model](./examples/postgres/)
* [Dealing with nested data models](./examples/nested-data/)

