dist_py_module

Distributing python modules

View project on GitHub

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.

dist_py_module python checker dist_py_module package checker GitHub issues open GitHub contributors

Table of Contents

Installation

Used next development environment

debian linux os

dist_py_module python3 build

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

Tool structure

dist_py_module is based on OOP.

Generator structure

    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

Documentation Status

More documentation and info at

Contributing

Contributing to codecipher

License: GPL v3 License

Copyright (C) 2017 - 2024 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.

Python Software Foundation

Donate