Metadata-Version: 2.4
Name: initium-checktest-doc
Version: 0.1.1
Summary: Pylint plugin for Initium Odoo module migration checks (tests and docs)
Home-page: https://github.com/straconxsa/strx_tools/
Author: Initium Team
Author-email: Initium Team <info@initium.com>
License: LGPL-3
Project-URL: Homepage, https://github.com/straconxsa/strx_tools/
Project-URL: Bug Tracker, https://github.com/straconxsa/strx_tools/issues
Keywords: pylint,odoo,migration,initium
Classifier: Framework :: Odoo
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: pylint
Dynamic: author
Dynamic: home-page


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`:

```bash
pip install /odoo20/strx_tools/strx_pylint_initium/
```

Or if you are in the directory:

```bash
pip install .
```

Configuration
-------------

Add the plugin to your `.pylintrc` file:

```ini
[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**:
    ```bash
    pip install --user build twine
    ```

2.  **Build the package**:
    ```bash
    python3 -m build
    ```

3.  **Upload to PyPI (requires an account)**:
    ```bash
    python3 -m twine upload dist/*
    ```

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