Skip to main content

Pylint plugin for Initium Odoo module migration checks (tests and docs)

Project description

Initium Check Test & Doc (Pylint Plugin)

This plugin checks that Odoo modules marked with "migrate": "done" have the required structure:

  • A tests/ directory.
  • A documentation directory (static/readme/ or static/src/readme/).

Installation

You can install this plugin directly using pip:

pip install /odoo20/strx_tools/strx_pylint_initium/

Or if you are in the directory:

pip install .

Configuration

Add the plugin to your .pylintrc file:

[MASTER]
load-plugins=pylint_odoo,initium_checktest_doc

[MESSAGES CONTROL]
enable=missing-tests-dir,missing-docs-dir

Publishing Online

To publish this plugin to a private or public repository (like PyPI), follow these steps:

  1. Ensure you have build and twine installed:

    pip install --user build twine
    
  2. Build the package:

    python3 -m build
    
  3. Upload to PyPI (requires an account):

    python3 -m twine upload dist/*
    

    Note: For public PyPI, the name initium-checktest-doc must be available.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

initium_checktest_doc-0.1.2.tar.gz (4.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

initium_checktest_doc-0.1.2-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file initium_checktest_doc-0.1.2.tar.gz.

File metadata

  • Download URL: initium_checktest_doc-0.1.2.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for initium_checktest_doc-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9a512b60df011101e724ca343f0aa25f95a0cfc5b8b8d9b8d9775188a8c618ef
MD5 e9be977ba30fc7ef0cad27d29fe483ab
BLAKE2b-256 43418b9d8baab0aeb4589fc4213ca4f84f108ba6f6bb994b132f6e556c61c72a

See more details on using hashes here.

File details

Details for the file initium_checktest_doc-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for initium_checktest_doc-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 008c1e9dc5faaf1c62173f651e51c2c51ce3ef240af6dd17b90a5a4c9cb3e096
MD5 9ce5ca630375c12e903b823aa9b87838
BLAKE2b-256 4362b9aec730fa5f1dd8a5bcf8e5f6dfbb4ba3ebe28963963200cd39ff06d65b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page