Create README project skeleton¶
gen_readme is tool for creating README project skeleton.
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 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
You can use Docker to create image/container, or You can use pip to install
# python3
pip3 install gen_readme
📦 Dependencies¶
gen_readme requires next modules and libraries
📁 Tool structure¶
gen_readme is based on OOP.
Tool structure
gen_readme/
├── 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
│ │ ├── gen_readme_command_definition.py
│ │ ├── gen_readme_command_executor.py
│ │ ├── icommand_definition.py
│ │ ├── icommand_executor.py
│ │ └── __init__.py
│ ├── config/
│ │ ├── gen_readme.cfg
│ │ ├── gen_readme.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 scaffolds README projects (coapthon, libcoap, node_coap).
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 |
|---|---|---|---|
gen_readme/__init__.py |
8 |
0 |
100% |
gen_readme/core/__init__.py |
9 |
0 |
100% |
gen_readme/core/model/__init__.py |
9 |
0 |
100% |
gen_readme/core/model/project_setup.py |
14 |
0 |
100% |
gen_readme/core/service/__init__.py |
9 |
0 |
100% |
gen_readme/core/service/engine.py |
27 |
0 |
100% |
gen_readme/core/service/iservice.py |
14 |
0 |
100% |
gen_readme/core/service/isubprocessor.py |
14 |
0 |
100% |
gen_readme/engine.py |
57 |
0 |
100% |
gen_readme/infrastructure/__init__.py |
8 |
0 |
100% |
gen_readme/infrastructure/cli/__init__.py |
9 |
0 |
100% |
gen_readme/infrastructure/cli/engine.py |
39 |
0 |
100% |
gen_readme/infrastructure/cli/icli.py |
14 |
0 |
100% |
gen_readme/infrastructure/cli/setup/__init__.py |
9 |
0 |
100% |
gen_readme/infrastructure/cli/setup/bundle.py |
22 |
0 |
100% |
gen_readme/infrastructure/cli/setup/dep_validator.py |
36 |
0 |
100% |
gen_readme/infrastructure/cli/setup/dependencies.py |
18 |
0 |
100% |
gen_readme/infrastructure/cli/setup/factory.py |
35 |
0 |
100% |
gen_readme/infrastructure/cli/setup/keys.py |
26 |
0 |
100% |
gen_readme/infrastructure/cli/setup/opt_validator.py |
36 |
0 |
100% |
gen_readme/infrastructure/cli/setup/options.py |
15 |
0 |
100% |
gen_readme/infrastructure/cli/setup/registry.py |
24 |
0 |
100% |
gen_readme/infrastructure/cli/setup/validator.py |
43 |
0 |
100% |
gen_readme/infrastructure/command/__init__.py |
9 |
0 |
100% |
gen_readme/infrastructure/command/command.py |
16 |
0 |
100% |
gen_readme/infrastructure/command/gen_readme_command_definition.py |
24 |
0 |
100% |
gen_readme/infrastructure/command/gen_readme_command_executor.py |
21 |
0 |
100% |
gen_readme/infrastructure/command/icommand_definition.py |
14 |
0 |
100% |
gen_readme/infrastructure/command/icommand_executor.py |
13 |
0 |
100% |
gen_readme/infrastructure/subprocessor.py |
58 |
0 |
100% |
gen_readme/setup/__init__.py |
9 |
0 |
100% |
gen_readme/setup/bundle.py |
23 |
0 |
100% |
gen_readme/setup/dep_validator.py |
36 |
0 |
100% |
gen_readme/setup/dependencies.py |
19 |
0 |
100% |
gen_readme/setup/factory.py |
48 |
0 |
100% |
gen_readme/setup/keys.py |
27 |
0 |
100% |
gen_readme/setup/opt_validator.py |
34 |
0 |
100% |
gen_readme/setup/options.py |
12 |
0 |
100% |
gen_readme/setup/registry.py |
32 |
0 |
100% |
gen_readme/setup/validator.py |
48 |
0 |
100% |
Total |
938 |
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/main/main.py
Running tool for creating new README project
python3 main.py generate-readme \
--type "avr" \
--project-name "gen_readme" \
--version "1.1.8" \
--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" \
--output "./demo_readme"
📚 Docs¶
More documentation and info at
👥 Contributing¶
📄 Copyright and licence¶
Copyright (C) 2025 - 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.