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.1.tar.gz (2.9 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.1-py3-none-any.whl (2.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for initium_checktest_doc-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c661031fa1bad3beced6ab33b9e2f5c568715b16cf09b35a51d5ca0044061507
MD5 f378e3db57afb39c7adcc6be3c224631
BLAKE2b-256 809c4d1a08dda47b0eb83bf294c27d901d5fcfa5a3b489eda806a8fed176f030

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for initium_checktest_doc-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 26f9e5010cfbcadf7084a986da539f7eae0cc9e1cd5dc61ae3719bb1bcd64160
MD5 e6269a92bfecff4a19b1dcb84b9f4636
BLAKE2b-256 e57434514f74767fa662b3f70d62f157ca6a36df361b18840ff5247d562cc167

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