Metadata-Version: 2.1
Name: gen-form-model
Version: 1.5.3
Summary: Form model based on Django, Flask
Home-page: https://vroncevic.github.io/gen_form_model/
Author: Vladimir Roncevic
Author-email: elektron.ronca@gmail.com
License: GPL 2017 Free software to use and distributed it.
Keywords: form model,django form,flask form
Platform: POSIX
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Description-Content-Type: text/markdown
Requires-Dist: ats-utilities
Requires-Dist: Flask
Requires-Dist: Flask-Migrate
Requires-Dist: Flask-Script
Requires-Dist: coverage
Requires-Dist: WTForms
Requires-Dist: Flask-Login
Requires-Dist: Flask-BCrypt
Requires-Dist: Flask-Bootstrap
Requires-Dist: Flask-DebugToolbar
Requires-Dist: Flask-SQLAlchemy
Requires-Dist: Flask-Testing
Requires-Dist: Flask-WTF
Requires-Dist: Django

<img align="right" src="https://raw.githubusercontent.com/vroncevic/gen_form_model/dev/docs/gen_form_model_logo.png" width="25%">

# Generate Form Model (Django/Flask)

**gen_form_model** is tool for generation form model for:

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

![Python package](https://github.com/vroncevic/gen_form_model/workflows/Python%20package%20gen_form_model/badge.svg?branch=master) [![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)

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**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)
- [Generation process](#generation-process)
- [Tool structure](#tool-structure)
- [Docs](#docs)
- [Copyright and Licence](#copyright-and-licence)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

### Installation

![Install Python2 Package](https://github.com/vroncevic/gen_form_model/workflows/Install%20Python2%20Package%20gen_form_model/badge.svg?branch=master) ![Install Python3 Package](https://github.com/vroncevic/gen_form_model/workflows/Install%20Python3%20Package%20gen_form_model/badge.svg?branch=master)

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

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

You can install by using pip
```
# python2
pip install gen-form-model
# python3
pip3 install gen-form-model
```

##### Install using setuptools

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

To install modules, locate and run setup.py with arguments
```
tar xvzf gen_form_model-x.y.z.tar.gz
cd gen_form_model-x.y.z/
# python2
pip install -r requirements.txt
python setup.py install_lib
python setup.py install_egg_info
python setup.py install_data
# 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.

[![gen_form_model docker checker](https://github.com/vroncevic/gen_form_model/workflows/gen_form_model%20docker%20checker/badge.svg)](https://github.com/vroncevic/gen_form_model/actions?query=workflow%3A%22gen_form_model+docker+checker%22)

### Dependencies

**gen_form_model** requires next modules and libraries:

* [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/ats_utilities)
* [Flask-WTF - Simple integration of Flask and WTForms](https://pypi.org/project/Flask-WTF/)
* [Django - High-level Python Web framework](https://pypi.org/project/Django/)

### Generation process

Generation flow:

![alt tag](https://raw.githubusercontent.com/vroncevic/gen_form_model/dev/docs/gen_form_model_flow.png)

### Tool structure

**gen_form_model** is based on OOP:

![alt tag](https://raw.githubusercontent.com/vroncevic/gen_form_model/dev/docs/gen_form_model.png)

Generator structure:
```
gen_form_model/
├── conf/
│   ├── gen_form_model.cfg
│   ├── 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
└── run/
    └── gen_form_model_run.py
```

### Docs

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

More documentation and info at:
* [gen_form_model.readthedocs.io](https://gen_form_model.readthedocs.io/en/latest/)
* [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 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 2.x/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://psfmember.org/index.php?q=civicrm/contribute/transact&reset=1&id=2)


