Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vroncevic/dist_py_module
Distributing python modules
https://github.com/vroncevic/dist_py_module
distributed generator install-script linux macos module pip python3 qnx setup setuptools temaplate tool unix
Last synced: 21 days ago
JSON representation
Distributing python modules
- Host: GitHub
- URL: https://github.com/vroncevic/dist_py_module
- Owner: vroncevic
- License: gpl-3.0
- Created: 2017-02-19T21:35:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-07T22:58:52.000Z (4 months ago)
- Last Synced: 2024-08-09T21:19:14.574Z (3 months ago)
- Topics: distributed, generator, install-script, linux, macos, module, pip, python3, qnx, setup, setuptools, temaplate, tool, unix
- Language: Python
- Homepage: https://vroncevic.github.io/dist_py_module
- Size: 7.73 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Generate setup.py
**dist_py_module** is toolset for generation of setup.py.
Developed in **[python](https://www.python.org/)** 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.
[](https://github.com/vroncevic/dist_py_module/actions/workflows/dist_py_module_python_checker.yml) [](https://github.com/vroncevic/dist_py_module/actions/workflows/dist_py_module_package.yml) [](https://github.com/vroncevic/dist_py_module/issues) [](https://github.com/vroncevic/dist_py_module/graphs/contributors)
**Table of Contents**
- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using build](#install-using-build)
- [Install using py setup](#install-using-py-setup)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Tool structure](#tool-structure)
- [Code coverage](#code-coverage)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and licence](#copyright-and-licence)
### Installation
Used next development environment
[](https://github.com/vroncevic/dist_py_module/actions/workflows/dist_py_module_python3_build.yml)
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](https://pypi.org/project/dist-py-module/)**.
You can install by using pip
```bash
# python3
pip3 install dist-py-module
```
##### Install using build
Navigate to **[release page](https://github.com/vroncevic/dist_py_module/releases)** download and extract release archive.
To install **dist-py-module** run
```bash
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](https://github.com/vroncevic/dist_py_module/releases/)** download and extract release archive.
To install **dist_py_module** type the following
```bash
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](https://pypi.org/project/dist-py-module/)
### Tool structure
**dist_py_module** is based on OOP.
Generator structure
```bash
dist_py_module/
├── conf/
│ ├── dist_py_module.cfg
│ ├── dist_py_module.logo
│ ├── dist_py_module_util.cfg
│ ├── project.yaml
│ └── template/
│ ├── MANIFEST.template
│ ├── pyproject.template
│ ├── setup_package.template
│ ├── setup.template
│ └── setup_tool.template
├── __init__.py
├── log/
│ └── dist_py_module.log
├── pro/
│ ├── __init__.py
│ ├── read_template.py
│ └── write_template.py
├── py.typed
└── run/
└── dist_py_module_run.py
6 directories, 16 files
```
### Code coverage
| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `dist_py_module/__init__.py` | 70 | 14 | 80% |
| `dist_py_module/pro/__init__.py` | 81 | 3 | 96% |
| `dist_py_module/pro/read_template.py` | 45 | 2 | 96% |
| `dist_py_module/pro/write_template.py` | 54 | 4 | 93% |
| **Total** | 250 | 23 | 91% |
### Docs
[](https://dist-py-module.readthedocs.io/en/latest/?badge=latest)
More documentation and info at
* [dist_py_module.readthedocs.io](https://dist-py-module.readthedocs.io/en/latest/)
* [www.python.org](https://www.python.org/)
### Contributing
[Contributing to codecipher](CONTRIBUTING.md)
### Copyright and licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2017 - 2024 by [vroncevic.github.io/dist_py_module](https://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.
[](https://www.python.org/psf/)
[](https://www.python.org/psf/donations/)