gen-py-tool 1.2.3

Generating python tool

Generate Python Tool

gen_py_tool is toolset for generation of Python tool.

Developed in python 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.

Table of Contents

• Installation
  • Install using pip
  • Install using setuptools
  • Install using docker
• Dependencies
• Generation flow of py tool
• Tool structure
• Docs
• Copyright and licence

Installation

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.

You can install by using pip

# python2
pip install gen-py-tool
# python3
pip3 install gen-py-tool

Install using setuptools

Navigate to release page download and extract release archive.

To install modules, locate and run setup.py, type the following:

tar xvzf gen_py_tool-x.y.z.tar.gz
cd gen_py_tool-x.y.z
# python2
pip install -r requirements.txt
python setup.py install_lib
python setup.py install_data
python setup.py install_egg_info
# 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_py_tool requires next modules and libraries:

• ats-utilities - Python App/Tool/Script Utilities

Generation flow of py tool

Base flow of generation process:

Tool structure

gen_py_tool is based on OOP:

Generator structure:

gen_py_tool/
├── conf/
│   ├── element/
│   │   ├── substitute_generator.yaml
│   │   └── substitute_tool.yaml
│   ├── gen_py_tool.cfg
│   ├── gen_py_tool_util.cfg
│   ├── project.yaml
│   ├── schema/
│   │   ├── schema_generator.yaml
│   │   └── schema_tool.yaml
│   └── template/
│       ├── generator/
│       │   ├── editorconfig.template
│       │   ├── generator_configuration.template
│       │   ├── generator_configuration_util.template
│       │   ├── generator_io_class.template
│       │   ├── generator_process_class.template
│       │   ├── generator_read_template.template
│       │   ├── generator_test.template
│       │   ├── generator_write_template.template
│       │   └── run_generator.template
│       ├── template_generator.yaml
│       ├── template_tool.yaml
│       └── tool/
│           ├── editorconfig.template
│           ├── run_tool.template
│           ├── tool_configuration.template
│           ├── tool_configuration_util.template
│           └── tool_name_class.template
├── __init__.py
├── log/
│   └── gen_py_tool.log
├── pro/
│   ├── config/
│   │   ├── __init__.py
│   │   ├── pro_name.py
│   │   ├── pro_selector.py
│   │   └── pro_type.py
│   ├── element/
│   │   ├── element_container.py
│   │   ├── element_keys.py
│   │   └── __init__.py
│   ├── factory/
│   │   ├── collectiner/
│   │   │   ├── gen/
│   │   │   │   ├── base.py
│   │   │   │   └── __init__.py
│   │   │   ├── __init__.py
│   │   │   └── tool/
│   │   │       ├── base.py
│   │   │       └── __init__.py
│   │   ├── extractiner/
│   │   │   ├── gen/
│   │   │   │   ├── base.py
│   │   │   │   └── __init__.py
│   │   │   ├── __init__.py
│   │   │   └── tool/
│   │   │       ├── base.py
│   │   │       └── __init__.py
│   │   ├── gen/
│   │   │   ├── deploy_gen.py
│   │   │   ├── gen_elements.py
│   │   │   ├── __init__.py
│   │   │   └── prepare_gen.py
│   │   ├── __init__.py
│   │   └── tool/
│   │       ├── deploy_tool.py
│   │       ├── __init__.py
│   │       ├── prepare_tool.py
│   │       └── tool_elements.py
│   ├── __init__.py
│   ├── read_template.py
│   ├── schema/
│   │   ├── __init__.py
│   │   ├── schema_container.py
│   │   └── schema_keys.py
│   ├── template/
│   │   ├── __init__.py
│   │   ├── template_container.py
│   │   └── template_keys.py
│   └── write_template.py
└── run/
    └── gen_py_tool_run.py

Docs

More documentation and info at:

• gen_py_tool.readthedocs.io
• www.python.org

Copyright and licence

Copyright (C) 2017 by vroncevic.github.io/gen_py_tool

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