Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vroncevic/gen_data_model
Generate Data Model
https://github.com/vroncevic/gen_data_model
data-model database django flask generator linux macos orm python3 qnx sqlalchemy template unix
Last synced: 14 days ago
JSON representation
Generate Data Model
- Host: GitHub
- URL: https://github.com/vroncevic/gen_data_model
- Owner: vroncevic
- License: gpl-3.0
- Created: 2017-03-06T21:53:28.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T16:35:22.000Z (4 months ago)
- Last Synced: 2024-10-10T23:49:21.326Z (27 days ago)
- Topics: data-model, database, django, flask, generator, linux, macos, orm, python3, qnx, sqlalchemy, template, unix
- Language: Python
- Homepage: https://vroncevic.github.io/gen_data_model
- Size: 7.48 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Generate Data Model (Django/Flask/SQLAlchemy)
**gen_data_model** is tool generator of data model for
* Django FWK
* Flask FWK
* SQLAlchemy FWK
Developed in **[python](https://www.python.org/)** code.
The README is used to introduce the modules and provide instructions on
how to install the modules, any machine dependencies it may have and any
other information that should be provided before the modules are installed.
[](https://github.com/vroncevic/gen_data_model/actions/workflows/gen_data_model_python_checker.yml) [](https://github.com/vroncevic/gen_data_model/actions/workflows/gen_data_model_package.yml) [](https://github.com/vroncevic/gen_data_model/issues) [](https://github.com/vroncevic/gen_data_model/graphs/contributors)
**Table of Contents**
- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using build](#install-using-build)
- [Install using py setup](#install-using-py-setup)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Tool structure](#tool-structure)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and licence](#copyright-and-licence)
### Installation
Used next development environment
[](https://github.com/vroncevic/gen_data_model/actions/workflows/gen_data_model_python3_build.yml)
Currently there are three ways to install tool
* Install process based on using pip mechanism
* Install process based on build mechanism
* Install process based on setup.py mechanism
* Install process based on docker mechanism
##### Install using pip
Python is located at **[pypi.org](https://pypi.org/project/gen_data_model/)**.
You can install by using pip
```bash
#python3
pip3 install gen_data_model
```
##### Install using build
Navigate to **[release page](https://github.com/vroncevic/gen_data_model/releases)** download and extract release archive.
To install **gen_data_model** run
```bash
tar xvzf gen_data_model-x.y.z.tar.gz
cd gen_data_model-x.y.z
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build --no-isolation --wheel
pip3 install dist/gen_data_model-x.y.z-py3-none-any.whl
rm -f get-pip.py
```
##### Install using py setup
Navigate to **[release page](https://github.com/vroncevic/gen_data_model/releases)** download and extract release archive.
To install **gen_data_model** locate and run setup.py
```bash
tar xvzf gen_data_model-x.y.z.tar.gz
cd gen_data_model-x.y.z
#python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
python3 setup.py install_data
```
##### Install using docker
You can use Dockerfile to create image/container.
### Dependencies
**gen_data_model** requires next modules and libraries
* [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/gen_data_model)
### Tool structure
**gen_data_model** is based on OOP
Generator structure
```bash
gen_data_model/
├── conf/
│ ├── gen_data_model.cfg
│ ├── gen_data_model.logo
│ ├── gen_data_model_util.cfg
│ ├── model_types.yaml
│ └── template/
│ ├── django_base_model.template
│ ├── django.template
│ ├── flask_base_model.template
│ ├── flask.template
│ ├── sqlalchemy_base_model.template
│ └── sqlalchemy.template
├── __init__.py
├── log/
│ └── gen_data_model.log
├── pro/
│ ├── __init__.py
│ ├── read_template.py
│ └── write_template.py
├── py.typed
└── run/
└── gen_data_model_run.py
6 directories, 17 files
```
### Code coverage
| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_data_model/__init__.py` | 75 | 14 | 81% |
| `gen_data_model/pro/__init__.py` | 66 | 2 | 97% |
| `gen_data_model/pro/read_template.py` | 34 | 2 | 94% |
| `gen_data_model/pro/write_template.py` | 53 | 2 | 96% |
| **Total** | 228 | 20 | 91% |
### Docs
[](https://gen-data-model.readthedocs.io/projects/gen_data_model/en/latest/?badge=latest)
More documentation and info at
* [gen_data_model.readthedocs.io](https://gen-data-model.readthedocs.io/en/latest/)
* [www.python.org](https://www.python.org/)
### Contributing
[Contributing to gen_data_model](CONTRIBUTING.md)
### Copyright and licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2017 - 2024 by [vroncevic.github.io/gen_data_model](https://vroncevic.github.io/gen_data_model/)
**gen_data_model** is free software; you can redistribute it and/or modify
it under the same terms as Python itself, either Python version 3.x or,
at your option, any later version of Python 3 you may have available.
Lets help and support PSF.
[](https://www.python.org/psf/)
[](https://www.python.org/psf/donations/)