DBgen
---Documentation: https://dbgen.modelyst.com
Github: https://github.com/modelyst/dbgen
❗ Please note that this project is actively under major rewrites and installations are subject to breaking changes.
DBgen (Database Generator) is an open-source Python library for connecting raw data, scientific theories, and relational databases. The package was designed with a focus on the developer experience at the core. DBgen was initially developed by Modelyst.
What is DBgen?
DBgen was designed to support scientific data analysis with the following characteristics:
-
Transparent
- Because scientific efforts ought be shareable and mutually understandable.
-
Flexible
- Because scientific theories are under continuous flux.
-
Maintainable
- Because the underlying scientific models one works with are complicated enough on their own, we can't afford to introduce any more complexity via our framework.
DBGen is an opinionated ETL tool. While many other ETL tools exist, they rarely give the tools necessary for a scientific workflow. DBGen is a tool that helps populate a single postgresql database using a transparent, flexible, and mainatable data pipeline.
Alternative tools
Orchestrators: Many tools exist to orchestrate python workflows. However, these tools often often are too general to help the average scientist wrangle their data or are so specific to storing a given workflow type they lack the flexibility needed to address the specifics of a scientist's data problems. Many other tools also come packaged with powerful
General Orchestration Tools
Computational Science Workflow Tools
What isn't DBgen?
-
An ORM tool (see Hibernate for Java or SQLAlchemy for Python)
- DBGen utilizes the popular SQLAlchemy ORM to operate at an even higher level extraction, allowing the users to build pipelines and schema without actively thinking about the database tables or insert and select statements required to connect the workflow together.
-
A database manager (see MySQLWorkbench, DBeaver, TablePlus, etc.)
-
An opinionated tool with a particular schema for scientific data / theories.
Getting DBgen
Via Github
Currently, the only method of installing DBgen is through Github. This is best done by using the poetry package manager. To do this, first clone the repo to a local directory. Then use the command poetry install in the directory to install the required dependencies. You will need at least python 3.7 to install the package.
# Get DBgen
git clone https://github.com/modelyst/dbgen
cd ./dbgen
# Get Poetry
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3 -
# Install Poetrywhich ma
poetry install
poetry shell
# Test dbgen
dbgen serialize dbgen.example.main:make_model
Via Pip
pip install modelyst-dbgen
API documentation
Documentation of modules and classes can be found in API docs </modules>.
Reporting bugs
Please report any bugs and issues at DBgen's Github Issues page.
License
DBgen is released under the Apache 2.0 License.
Metadata
Release files for modelyst-dbgen 0.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| modelyst-dbgen-0.6.1.tar.gz | 85.4 kB | Without provenance | Details for modelyst-dbgen-0.6.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| modelyst_dbgen-0.6.1-py3-none-any.whl | Python 3 | none | any | Details for modelyst_dbgen-0.6.1-py3-none-any.whl |
Total release size: 207.9 kB
Release files / modelyst-dbgen-0.6.1.tar.gz
| Download URL | modelyst-dbgen-0.6.1.tar.gz |
|---|---|
| Size | 85.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0059460e8fa575909256e4484f4aa3af6532b5685350a005e5a6070d2ff22d54
|
|
BLAKE2b-256 checksum How to use checksums |
42f6d38c25aac387479dca3f840669b8b668fa4eaeadfa3c6c92917daba5403c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.12 CPython/3.9.10 Linux/5.11.0-1028-azure
|
Release files / modelyst_dbgen-0.6.1-py3-none-any.whl
| Download URL | modelyst_dbgen-0.6.1-py3-none-any.whl |
|---|---|
| Size | 122.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5a43ddc72ab1652bb8649858527d23a54b4690e4233f089b4d4fc6fc390e4793
|
|
BLAKE2b-256 checksum How to use checksums |
7f9ae8446d48eb7a98149148c8a614b41d7a6f9e1828ef1f665716faedb1d041
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.1.12 CPython/3.9.10 Linux/5.11.0-1028-azure
|
Security for modelyst-dbgen 0.6.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.