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 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.
Table of Contents
Installation
Used next development environment
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.
You can install by using pip
#python3
pip3 install gen_data_model
Install using build
Navigate to release page download and extract release archive.
To install gen_data_model run
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 download and extract release archive.
To install gen_data_model locate and run setup.py
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
Tool structure
gen_data_model is based on OOP
Generator structure
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
More documentation and info at
Contributing
Contributing to gen_data_model
Copyright and licence
Copyright (C) 2017 - 2024 by 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.
