Generate setup.py

dist_py_module is toolset for generation of setup.py.

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
  • Install using pip
  • Install using build
  • Install using py setup
  • Install using docker
• Dependencies
• Tool structure
• Code coverage
• Usage
• Docs
• Contributing
• Copyright and licence

Installation

Used next development environment

Currently there are four ways to install framework

• 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 dist-py-module

Install using build

Navigate to release page download and extract release archive.

To install dist-py-module run

tar xvzf dist-py-module-x.y.z.tar.gz
cd dist-py-module-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/dist-py-module-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 dist_py_module type the following

tar xvzf dist_py_module-x.y.z.tar.gz
cd dist_py_module-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

dist_py_module requires next modules and libraries

• dist-py-module - Python App/Tool/Script Utilities

Tool structure

dist_py_module is based on OOP.

Generator structure

Click to expand framework structure

    dist_py_module/
         ├── application/
         │   ├── __init__.py
         │   ├── service.py
         │   └── service_bundle.py
         ├── dist_py_module_bundle.py
         ├── domain/
         │   ├── __init__.py
         │   ├── models.py
         │   └── ports/
         │       ├── ifile_gen.py
         │       ├── ifile_writer.py
         │       ├── __init__.py
         │       └── itemplate_provider.py
         ├── engine.py
         ├── infrastructure/
         │   ├── cli.py
         │   ├── cli_bundle.py
         │   ├── config/
         │   │   ├── dist_py_module.cfg
         │   │   └── dist_py_module.logo
         │   ├── file_writer.py
         │   ├── gen_setup_command.py
         │   ├── icli.py
         │   ├── icli_command.py
         │   ├── __init__.py
         │   ├── template_provider.py
         │   └── templates/
         │       └── setup.template
         ├── __init__.py
         └── py.typed

     7 directories, 24 files

Code coverage

Click to expand code coverage

Name	Stmts	Miss	Cover
dist_py_module/__init__.py	8	0	100%
dist_py_module/application/__init__.py	8	0	100%
dist_py_module/application/service.py	30	0	100%
dist_py_module/application/service_bundle.py	28	0	100%
dist_py_module/dist_py_module_bundle.py	41	0	100%
dist_py_module/domain/__init__.py	8	0	100%
dist_py_module/domain/models.py	18	0	100%
dist_py_module/domain/ports/__init__.py	8	0	100%
dist_py_module/domain/ports/ifile_gen.py	11	0	100%
dist_py_module/domain/ports/ifile_writer.py	10	0	100%
dist_py_module/domain/ports/itemplate_provider.py	10	0	100%
dist_py_module/engine.py	69	0	100%
dist_py_module/infrastructure/__init__.py	8	0	100%
dist_py_module/infrastructure/cli.py	36	0	100%
dist_py_module/infrastructure/cli_bundle.py	33	0	100%
dist_py_module/infrastructure/file_writer.py	30	0	100%
dist_py_module/infrastructure/gen_setup_command.py	35	0	100%
dist_py_module/infrastructure/icli.py	11	0	100%
dist_py_module/infrastructure/icli_command.py	14	0	100%
dist_py_module/infrastructure/template_provider.py	29	0	100%
Total	445	0	100%

Usage

Install package

pip3 install dist_py_module

Prepare main entry point by downloading main.py or create your own.

wget -O main.py https://raw.githubusercontent.com/vroncevic/dist_py_module/master/main.py

Running tool for creating new distributing py module

mkdir -p demo/mytool/

python3 main.py setup --package-name "dist_py_module" --version "3.1.1" --description "Package for distributing Python packages." --author "Vladimir Roncevic" --email "elektron.ronca@gmail.com" --github "vroncevic" --license "GNU General Public License (GPL)" --with-readme "True"

Docs

More documentation and info at

• dist_py_module.readthedocs.io
• www.python.org

Contributing

Contributing to codecipher

Copyright and licence

Copyright (C) 2017 - 2026 by vroncevic.github.io/dist_py_module

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