DBgen (Database Generator) is an open-source Python library for connecting raw data, scientific theories, and relational databases
Project description
DBgen
---Documentation: https://dbgen.modelyst.com
Github: https://github.com/modelyst/dbgen
DBgen (Database Generator) is an open-source Python library for connecting raw data, scientific theories, and relational databases. These are some of the main features:
- Very easy to work with
- Integration with the PostgreSQL databases.
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. ETL tools exist but they rarely give the tools necessary for a scientific workflow. Opinionated aspect: it really cares about what the end product is (ID columns on all the tables). We're dealing with a much more restricted ETL problem (extracting and ).
Comparison to
-
- Has a priority for ETL scalability
-
- We don't focus on the actual submission of computational science workflows.
What isn't DBgen?
-
An ORM tool (see Hibernate for Java or SQLAlchemy for Python)
- DBgen operates at a higher level of abstrload, not exposing the user to low level SQL commands like SELECT or INSERT.
-
A database manager (see MySQLWorkbench, DBeaver, TablePlus, etc.)
-
An opinioniated 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.8 to install the package.
This installation process is still in development, please contact the DBgen if you encounter issues. Moving forward we plan to use make dbgen installable through pip
.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for modelyst_dbgen-0.4.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f79deafa48891177fc1a4f781dbece8f4baad329aa33ff9f1ccb5f2d346fa9af |
|
MD5 | 2ddf0d3b203944c898a9c67200944a65 |
|
BLAKE2b-256 | aa9f353d19d9af1d849b1f92dbc3a74395a9233e240db7dd583636f8ae0b307f |