
Security News
Deno 2.4 Brings Back deno bundle, Improves Dependency Management and Observability
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.
This plugin is based on oca-gen-addon-readme from the repository OCA/maintainer-tools.git. The original version is licensed under AGPL-3.
You can find the terms of the license in the LICENSE file available in this repository.
This small utility generates high-quality README.rst files along with a web page, which is displayed when reviewing the module's information. The webpage is located in the static/index.html directory.
The README generation starts by creating a readme directory in the module, containing a number of .rst files called Fractions where the developer can describe the module's functionalities in detail.
tony_stark_module
├── views
├── readme
| ├── CONFIGURE.rst
| ├── CONTRIBUTORS.rst
| ├── CREDITS.rst
| ├── DESCRIPTION.rst
| ├── HISTORY.rst
| ├── INSTALL.rst
| ├── READMAP.rst
| └── USAGE.rst
├── reports
├── static
└── views
You can use this module as a pre-commit plugin this way
- repo: https://github.com/quilsoft-org/gen-readme.git
rev: 1.3.53
hooks:
- id: gen-readme
args:
- --min-description-words=20
- --website=https://quilsoft.com
- --org-name=quilsoft-org
- --author=Quilsoft
You can install the plugin locally and run it against a set of modules. To do this, you need to install it with:
sudo pipx install gen-odoo-readme
See proyect details in pypi.org/gen-odoo/readme
Use the gen-readme --help command for detailed usage instructions:
Usage: gen_readme.py [OPTIONS] [FILES]...
main function for gen_readme
Options:
--addons DIRECTORY Directory containing several addons, the
README will be generated for all installable
addons found there...
--min-description-words INTEGER
Minimum number of words that the DESCRIPTION
section must contain. Default: 40
--website TEXT Partner website; the logo at the end of the
README is taken from this website
--org-name TEXT Github Organization from the partner.
Default: quilsoft-org
--author TEXT Tipically the intelectual author of the
module Default: Quilsoft
--help Show this message and exit.
When working locally, you must provide the --addons-dir DIRECTORY option to make it work
FAQs
Tool to create README.rst files for Odoo
We found that gen-odoo-readme demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.
Security News
CVEForecast.org uses machine learning to project a record-breaking surge in vulnerability disclosures in 2025.
Security News
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.