Create Python package setup¶
dist_py_module is a tool for distributing Python packages by generating setup.py files.
Developed in python code.
The README is used to introduce the tool and provide instructions on how to install the tool, any machine dependencies it may have and any other information that should be provided before the tool is installed.
🚀 Installation¶
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
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/dist_py_module-*-py3-none-any.whl
rm -f get-pip.py
You can use Docker to create image/container, or You can use pip to install
# python3
pip3 install dist_py_module
📦 Dependencies¶
dist_py_module requires next modules and libraries
📁 Tool structure¶
dist_py_module is based on OOP.
Tool structure
dist_py_module/
├── core/
│ ├── __init__.py
│ ├── model/
│ │ ├── __init__.py
│ │ └── project_setup.py
│ └── service/
│ ├── engine.py
│ ├── __init__.py
│ ├── iservice.py
│ └── isubprocessor.py
├── engine.py
├── infrastructure/
│ ├── cli/
│ │ ├── engine.py
│ │ ├── icli.py
│ │ ├── __init__.py
│ │ └── setup/
│ │ ├── bundle.py
│ │ ├── dep_validator.py
│ │ ├── dependencies.py
│ │ ├── factory.py
│ │ ├── __init__.py
│ │ ├── keys.py
│ │ ├── opt_validator.py
│ │ ├── options.py
│ │ ├── registry.py
│ │ └── validator.py
│ ├── command/
│ │ ├── command.py
│ │ ├── dist_py_module_command_definition.py
│ │ ├── dist_py_module_command_executor.py
│ │ ├── icommand_definition.py
│ │ ├── icommand_executor.py
│ │ └── __init__.py
│ ├── config/
│ │ ├── dist_py_module.cfg
│ │ ├── dist_py_module.logo
│ │ ├── scheme.json
│ │ └── templates.tgz
│ ├── __init__.py
│ └── subprocessor.py
├── __init__.py
├── py.typed
└── setup/
├── bundle.py
├── dep_validator.py
├── dependencies.py
├── factory.py
├── __init__.py
├── keys.py
├── opt_validator.py
├── options.py
├── registry.py
└── validator.py
10 directories, 45 files
✨ Features¶
Automatically generates setup.py files with custom options for Python packages.
Provides a modular and extensible architecture based on OOP and SOLID principles.
Includes command line interface (CLI) support via a command/executor structure.
Robust validation of project bundles, dependencies, and options.
Comes with configurable templates and JSON schema definitions.
High code quality with full type checking and 100% unit test coverage.
📊 Code coverage¶
Name |
Stmts |
Miss |
Cover |
|---|---|---|---|
dist_py_module/__init__.py |
8 |
0 |
100% |
dist_py_module/core/__init__.py |
9 |
0 |
100% |
dist_py_module/core/model/__init__.py |
9 |
0 |
100% |
dist_py_module/core/model/project_setup.py |
14 |
0 |
100% |
dist_py_module/core/service/__init__.py |
9 |
0 |
100% |
dist_py_module/core/service/engine.py |
27 |
0 |
100% |
dist_py_module/core/service/iservice.py |
14 |
0 |
100% |
dist_py_module/core/service/isubprocessor.py |
14 |
0 |
100% |
dist_py_module/engine.py |
57 |
0 |
100% |
dist_py_module/infrastructure/__init__.py |
8 |
0 |
100% |
dist_py_module/infrastructure/cli/__init__.py |
9 |
0 |
100% |
dist_py_module/infrastructure/cli/engine.py |
39 |
0 |
100% |
dist_py_module/infrastructure/cli/icli.py |
14 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/__init__.py |
9 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/bundle.py |
22 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/dep_validator.py |
36 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/dependencies.py |
18 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/factory.py |
35 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/keys.py |
26 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/opt_validator.py |
36 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/options.py |
15 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/registry.py |
24 |
0 |
100% |
dist_py_module/infrastructure/cli/setup/validator.py |
43 |
0 |
100% |
dist_py_module/infrastructure/command/__init__.py |
9 |
0 |
100% |
dist_py_module/infrastructure/command/command.py |
16 |
0 |
100% |
dist_py_module/infrastructure/command/dist_py_module_command_definition.py |
24 |
0 |
100% |
dist_py_module/infrastructure/command/dist_py_module_command_executor.py |
21 |
0 |
100% |
dist_py_module/infrastructure/command/icommand_definition.py |
14 |
0 |
100% |
dist_py_module/infrastructure/command/icommand_executor.py |
13 |
0 |
100% |
dist_py_module/infrastructure/subprocessor.py |
55 |
0 |
100% |
dist_py_module/setup/__init__.py |
9 |
0 |
100% |
dist_py_module/setup/bundle.py |
23 |
0 |
100% |
dist_py_module/setup/dep_validator.py |
36 |
0 |
100% |
dist_py_module/setup/dependencies.py |
19 |
0 |
100% |
dist_py_module/setup/factory.py |
48 |
0 |
100% |
dist_py_module/setup/keys.py |
27 |
0 |
100% |
dist_py_module/setup/opt_validator.py |
34 |
0 |
100% |
dist_py_module/setup/options.py |
12 |
0 |
100% |
dist_py_module/setup/registry.py |
32 |
0 |
100% |
dist_py_module/setup/validator.py |
48 |
0 |
100% |
Total |
935 |
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/main/main.py
Running tool for creating new Python setup.py file
python3 main.py setup --package-name "my-pkg" --version "1.0.0" --description "My description" --author "Me" --email "me@domain.com" --output ./demo/
📚 Docs¶
More documentation and info at
👥 Contributing¶
📄 Copyright and licence¶
Copyright (C) 2025 - 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.