gen-readme 1.1.6

Readme doc generator

Create README.md doc module

gen_readme is tool for creating README.md doc module.

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

Currently there are three ways to install package

• 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 package is located at pypi.org.

You can install by using pip

#python3
pip3 install gen_readme

Install using build

Navigate to release page download and extract release archive.

To install gen_readme type the following

tar xvzf gen_readme-x.y.z.tar.gz
cd gen_readme-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/gen_readme-*-py3-none-any.whl
rm -f get-pip.py
chmod 755 /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_readme_run.py
ln -s /usr/local/lib/python3.10/dist-packages/usr/local/bin/gen_readme_run.py /usr/local/bin/gen_readme_run.py

Install using py setup

Navigate to release page download and extract release archive.

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

tar xvzf gen_readme-x.y.z.tar.gz
cd gen_readme-x.y.z
#python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_egg_info
python3 setup.py install_data

Install using docker

You can use Dockerfile to create image/container.

Dependencies

gen_readme requires next modules and libraries

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

Tool structure

gen_readme is based on OOP

Generator structure

Click to expand framework structure

    gen_readme/
         ├── application/
         │   ├── __init__.py
         │   ├── service.py
         │   └── service_bundle.py
         ├── domain/
         │   ├── __init__.py
         │   ├── models.py
         │   └── ports/
         │       ├── ifile_gen.py
         │       ├── ifile_writer.py
         │       ├── __init__.py
         │       └── itemplate_provider.py
         ├── engine.py
         ├── gen_readme_bundle.py
         ├── infrastructure/
         │   ├── cli.py
         │   ├── cli_bundle.py
         │   ├── config/
         │   │   ├── gen_readme.cfg
         │   │   └── gen_readme.logo
         │   ├── file_writer.py
         │   ├── gen_readme_command.py
         │   ├── icli.py
         │   ├── icli_command.py
         │   ├── __init__.py
         │   ├── template_provider.py
         │   └── templates/
         │       ├── README_AVR.template
         │       ├── README_C.template
         │       ├── README_CC.template
         │       ├── README_JS.template
         │       ├── README_PL.template
         │       ├── README_PY.template
         │       ├── README_RPI.template
         │       ├── README_SH.template
         │       ├── README_STM.template
         │       └── README_VALA.template
         ├── __init__.py
         └── py.typed

     7 directories, 33 files

Code coverage

Click to expand code coverage

Name	Stmts	Miss	Cover
gen_readme/__init__.py	8	0	100%
gen_readme/application/__init__.py	8	0	100%
gen_readme/application/service.py	30	0	100%
gen_readme/application/service_bundle.py	28	0	100%
gen_readme/domain/__init__.py	8	0	100%
gen_readme/domain/models.py	20	0	100%
gen_readme/domain/ports/__init__.py	8	0	100%
gen_readme/domain/ports/ifile_gen.py	11	0	100%
gen_readme/domain/ports/ifile_writer.py	10	0	100%
gen_readme/domain/ports/itemplate_provider.py	10	0	100%
gen_readme/engine.py	69	0	100%
gen_readme/gen_readme_bundle.py	41	0	100%
gen_readme/infrastructure/__init__.py	8	0	100%
gen_readme/infrastructure/cli.py	36	0	100%
gen_readme/infrastructure/cli_bundle.py	33	0	100%
gen_readme/infrastructure/file_writer.py	30	0	100%
gen_readme/infrastructure/gen_readme_command.py	44	0	100%
gen_readme/infrastructure/icli.py	11	0	100%
gen_readme/infrastructure/icli_command.py	14	0	100%
gen_readme/infrastructure/template_provider.py	29	0	100%
Total	456	0	100%

Usage

Install package

pip3 install gen_readme

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

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

Running tool for creating new distributing py module

python3 main.py generate-readme \
    --type "avr" \
    --project-name "gen_readme" \
    --version "1.1.6" \
    --description "Generate README.md file" \
    --author-name "Vladimir Roncevic" \
    --author-url "https://vroncevic.github.io" \
    --license "MIT" \
    --repo-url "https://github.com/vroncevic/gen_readme" \
    --filename "README_AVR.md"

Docs

More documentation and info at

• gen_readme.readthedocs.io
• www.python.org

Contributing

Contributing to gen_readme

Copyright and licence

Copyright (C) 2020 - 2026 by vroncevic.github.io/gen_readme

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