hatch-odoo

一个用于与包含Odoo插件的项目的hatch(语言)插件。这个工具可以帮助你打包包含Odoo插件的工程，以便可以与pip一起安装

• 根据Odoo插件清单自动生成依赖项，
• 将插件打包到odoo/addons命名空间中，而不依赖于源项目布局，
• 在不修改--addons-path的情况下以可编辑模式安装插件，

💡 当与最终客户项目一起工作时，该项目最好使用。若要打包单个可重用的插件，请考虑whool项目。

目录

• hatch-odoo
  • 快速开始
  • 替代项目布局
  • 许可证

快速开始

假设你的项目仓库根目录包含你的出色Odoo插件，你可以通过创建一个类似于以下的pyproject.toml文件来设置它。

# Use the hatchling build backend, with the hatch-odoo plugin.
[build-system]
requires = ["hatchling", "hatch-odoo"]
build-backend = "hatchling.build"

[project]
name = "MyAwesomeProject"
version = "1.0"
readme = "README.md"
requires-python = ">=3.8"
# Dependencies are dynamic because they will be generated from Odoo addons manifests.
dynamic = ["dependencies"]

# Enable the hatch-odoo metadata hook to generate dependencies from addons manifests.
[tool.hatch.metadata.hooks.odoo-addons-dependencies]
# Enable the hatch-odoo build hook to package the Odoo addons into odoo/addons.
[tool.hatch.build.hooks.odoo-addons-dirs]

[tool.hatch-odoo]
# If our addons have non standard version numbers, let's help hatch-odoo discover the Odoo version.
odoo_version_override = "15.0"
# Let's add additional dependencies that are not declared in addons manifests.
dependencies = ["click-odoo-contrib"]
# Our addons are in the project root directory.
addons_dirs = ["."]

然后你可以以可编辑模式安装它，并使用以下过程在虚拟环境中安装其依赖项

# python3 -m venv .venv
# source .venv/bin/activate
# pip install --upgrade pip setuptools wheel
# pip install -r https://raw.githubusercontent.com/odoo/odoo/15.0/requirements.txt
# pip install -e git+https://github.com/odoo/odoo@15.0
# pip install -e .
# odoo

你的项目插件清单中声明的所有依赖项（如OCA插件和外部依赖项）将自动从PyPI下载和安装。

无需配置Odoo插件路径：由于插件安装在odoo/addons，因此默认的Python导入机制即可正常工作。

您可以使用pip freeze或其他工具来固定依赖关系以保证可重现性。pip-deepfreeze与git URL配合使用效果良好，但其他工具如pip-tools也可能同样适用。

替代项目布局

根据您的喜好和需求，有多种方法可以组织源代码。在tests/data中的测试项目每个都附有README，描述了布局和相应的权衡，并附有相应的pyproject.toml文件。

许可证

hatch-odoo遵循MIT许可证条款。