Skip to main content

List files from Odoo addon dependencies using manifestoo.

Project description

Akaidoo Logo

Akaidoo - vibe code your Odoo!

PyPI version Python versions License

Navigate the Odoo & OCA Maze: Instantly Gather Relevant Modules Files.


Akaidoo extends the manifestoo CLI to list and copy all relevant source files (Python models, XML views, wizards, data, reports, and even OpenUpgrade migration scripts) from a specific Odoo addon and its entire dependency tree. It's designed to feed AI LLMs.

Akaidoo bridges the AI gap for Odoo by helping you:

  • 🤖 Boost AI Tools: Feed precisely the right context to AI LLMs. Works best with Gemini and its 1 million tokens context.
  • 📝 Streamline Editing: Open all pertinent files in your editor with a single command.
  • 🧩 Understand Scope: Quickly grasp the breadth of an addon's interactions.
  • 🔍 Perform searches: (akaidoo sale_stock -c ~/DEV/odoo16/odoo.cfg | xargs grep "def _compute_price_unit")
  • 🚀 Accelerate Migrations: Gather module code, dependencies, and their corresponding OpenUpgrade migration scripts in one go.

Key Features

  • Deep Dependency Traversal: Leverages manifestoo to accurately resolve all direct and transitive dependencies.
  • Intelligent File Collection: Gathers .py (models, root files) and .xml (views, wizards, reports) from the identified addons.
  • OpenUpgrade Script Integration: Optionally include all migration scripts from a specified OpenUpgrade repository for the target addon and its dependencies (-u, --openupgrade).
  • Flexible Addon Discovery:
    • Use Odoo configuration files (-c, --odoo-cfg).
    • Specify addon paths directly (--addons-path).
    • Auto-detect from an importable odoo package.
  • Granular Filtering:
    • Include/exclude specific file types (models, views, wizards, reports).
    • Focus only on models or views.
    • Exclude Odoo core addons (--exclude-core) or common framework addons (--exclude-framework).
    • Intelligently skip trivial __init__.py files.
  • Versatile Output Modes:
    • List Paths: Print file paths to stdout (default).
    • To Clipboard: Copy the content of all found files to your clipboard (-x, --clipboard), each prefixed with its relative path – perfect for AI prompts!
    • To File: Dump all file contents into a single output file (-o, --output-file).
    • To Editor: Directly open all found files in your preferred editor (-e, --edit).
  • Shrink files to save tokens:
    • -s to shrink the Python methods in dependencies
    • -S to shrink the Python methods everywhere

Installation

The recommended way to install Akaidoo is using pipx (to install it in an isolated environment):

pipx install akaidoo

Alternatively, using pip:

pip install --user akaidoo

For clipboard functionality (-x): Akaidoo uses pyperclip. You might need to install it and its dependencies:

pip install pyperclip
# On Linux, you may also need:
# sudo apt-get install xclip  # or xsel

Quick Start

Imagine you're working on the sale_timesheet addon in an Odoo project.

  1. Get all relevant file paths for sale_timesheet and its dependencies: (Using your project's Odoo configuration file)
akaidoo sale_timesheet -c ~/path/to/your/odoo.conf
  1. Copy all Python model code for sale_timesheet (without its deps -l) to your clipboard for an AI prompt:
akaidoo sale_timesheet -c odoo.conf --only-models -l -x
*(Each file's content in the clipboard will be prefixed with `# FILEPATH: path/to/file.py`)*
  1. Open all Python and XML view files for project and its direct dependencies (excluding core) in Neovim (use --editor-cmd or EDITOR env var to specify a different editor):
akaidoo project -c odoo.conf --exclude-core --no-include-wizards --no-include-reports -e
*(This uses the `nvim -p` command to open files in tabs. It's especially handy when using AI plugins like Avante.)*
  1. Get only the files from the mrp addon itself, ignoring its dependencies, and save their content to a file (useful if you outgrow the clipboard size):
akaidoo mrp -c odoo.conf --only-target-addon -o mrp_context.txt
  1. Gather sale_stock files, its dependencies, AND its OpenUpgrade migration scripts: (Assuming your OpenUpgrade clone is at ~/OpenUpgrade)
akaidoo sale_stock -c odoo.conf -u ~/OpenUpgrade -o sale_stock_migration_context.txt
This will collect all standard module files for `sale_stock` and its dependencies, plus all files from `~/OpenUpgrade/openupgrade_scripts/scripts/sale_stock/`, `~/OpenUpgrade/openupgrade_scripts/scripts/ADDON_DEPENDENCY_1/`, etc., into `sale_stock_migration_context.txt`. This is powerful for feeding comprehensive context to an AI for migration tasks.
  1. Gather the files from any source directory:
akaidoo some_directory
If some_directory is not an Odoo addon, then for convenience, akaidoo will select all the files from some_directory (recursively) and copy their content to the clipboard (-x) or to a file (-o) according to the options. It will skip hidden files and __pycache__.

Exploring All Options: For a full list of options:

akaidoo --help

Contributing

Contributions, bug reports, and feature requests are very welcome! Please feel free to open an issue or submit a pull request on the GitHub repository.

License

Akaidoo is licensed under the MIT License.

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

akaidoo-1.1.0.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

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

akaidoo-1.1.0-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file akaidoo-1.1.0.tar.gz.

File metadata

  • Download URL: akaidoo-1.1.0.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for akaidoo-1.1.0.tar.gz
Algorithm Hash digest
SHA256 26b9e5335a3c1f5b6049389a4cf9e0cebc9562f08e90aa5bb3eb6001f26a4883
MD5 deefdb96e155410d7b84d1959ec8bf91
BLAKE2b-256 e0a7de73b7e523c8331aad837995e88826b3d596c27d7098b0e3fa6d2fa593ba

See more details on using hashes here.

Provenance

The following attestation bundles were made for akaidoo-1.1.0.tar.gz:

Publisher: publish.yml on akretion/akaidoo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file akaidoo-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: akaidoo-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for akaidoo-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd0767bdfb62c4bf460749a1fdc288d30ea36931ac7a85d201af3744db02ef9d
MD5 ad70640a3a236850bd2614fe2a77251e
BLAKE2b-256 930622b77257e980ad924dd6a2f5351288a3476db14ecf8dcca96e089aaff22b

See more details on using hashes here.

Provenance

The following attestation bundles were made for akaidoo-1.1.0-py3-none-any.whl:

Publisher: publish.yml on akretion/akaidoo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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