Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vroncevic/gen_form_model

Generate Form Model
https://github.com/vroncevic/gen_form_model

django flask form-model generator linux macos python3 template tool unix web-forms

Last synced: about 2 months ago
JSON representation

Generate Form Model

Awesome Lists containing this project

README

        

# Generate Form Model (Django/Flask)

**gen_form_model** is generator for form model:

* Django FWK
* Flask FWK

Developed in **[python](https://www.python.org/)** code: **100%**.

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.

[![gen_form_model python checker](https://github.com/vroncevic/gen_form_model/actions/workflows/gen_form_model_python_checker.yml/badge.svg)](https://github.com/vroncevic/gen_form_model/actions/workflows/gen_form_model_python_checker.yml) [![gen_form_model package checker](https://github.com/vroncevic/gen_form_model/actions/workflows/gen_form_model_package_checker.yml/badge.svg)](https://github.com/vroncevic/gen_form_model/actions/workflows/gen_form_model_package.yml) [![GitHub issues open](https://img.shields.io/github/issues/vroncevic/gen_form_model.svg)](https://github.com/vroncevic/gen_form_model/issues) [![GitHub contributors](https://img.shields.io/github/contributors/vroncevic/gen_form_model.svg)](https://github.com/vroncevic/gen_form_model/graphs/contributors)

**Table of Contents**

- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using setuptools](#install-using-setuptools)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Tool structure](#tool-structure)
- [Docs](#docs)
- [Copyright and Licence](#copyright-and-licence)

### Installation

![debian linux os](https://raw.githubusercontent.com/vroncevic/gen_form_model/dev/docs/debtux.png)

[![gen_form_model python3 build](https://github.com/vroncevic/gen_form_model/actions/workflows/gen_form_model_python3_build.yml/badge.svg)](https://github.com/vroncevic/gen_form_model/actions/workflows/gen_form_model_python3_build.yml)

Currently there are three ways to install tool:
* Install process based on pip
* Install process based on setup.py (setuptools)
* Install process based on docker mechanism

##### Install using pip

**gen_form_model** is located at **[pypi.org](https://pypi.org/project/gen-form-model/)**.

You can install by using pip

```bash
# python3
pip3 install gen-form-model
```

##### Install using build

Navigate to **[release page](https://github.com/vroncevic/gen_form_model/releases)** download and extract release archive.

To install **gen-form-model** run

```bash
tar xvzf gen-form-model-x.y.z.tar.gz
cd gen-form-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 -s --no-isolation --wheel
pip3 install dist/gen-form-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_form_model/releases/)** download and extract release archive.

To install **gen_form_model** type the following

```bash
tar xvzf gen_form_model-x.y.z.tar.gz
cd gen_form_model-x.y.z/
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_data
python3 setup.py install_egg_info
```

##### Install using docker

You can use Dockerfile to create image/container.

### Dependencies

**gen_form_model** requires next modules and libraries

* [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/ats_utilities)

### Tool structure

**gen_form_model** is based on OOP.

Generator structure

```bash
gen_form_model/
├── conf/
│   ├── gen_form_model.cfg
│   ├── gen_form_model.logo
│   ├── gen_form_model_util.cfg
│   ├── project.yaml
│   └── template/
│   ├── django.template
│   └── flask.template
├── __init__.py
├── log/
│   └── gen_form_model.log
├── pro/
│   ├── __init__.py
│   ├── read_template.py
│   └── write_template.py
├── py.typed
└── run/
└── gen_form_model_run.py

6 directories, 13 files
```

### Code coverage

| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_form_model/__init__.py` | 75 | 14 | 81% |
| `gen_form_model/pro/__init__.py` | 63 | 2 | 97% |
| `gen_form_model/pro/read_template.py` | 31 | 2 | 94% |
| `gen_form_model/pro/write_template.py` | 51 | 2 | 96% |
| **Total** | 220 | 20 | 91% |

### Docs

[![Documentation Status](https://readthedocs.org/projects/gen_form_model/badge/?version=latest)](https://gen-form-model.readthedocs.io/en/latest/?badge=latest)

More documentation and info at

* [gen_form_model.readthedocs.io](https://gen-form-model.readthedocs.io)
* [www.python.org](https://www.python.org/)

### Copyright and Licence

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Copyright (C) 2017 - 2024 by [vroncevic.github.io/gen_form_model](https://vroncevic.github.io/gen_form_model/)

**gen_form_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.

[![Python Software Foundation](https://raw.githubusercontent.com/vroncevic/gen_form_model/dev/docs/psf-logo-alpha.png)](https://www.python.org/psf/)

[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.python.org/psf/donations/)