Metadata-Version: 2.4
Name: hatch-tryton
Version: 0.1.0
Summary: A hatchling plugin for Tryton
Project-URL: homepage, https://www.tryton.org/
Project-URL: changelog, https://code.tryton.org/hatch-tryton/-/blob/branch/default/CHANGELOG
Project-URL: forum, https://discuss.tryton.org/tags/hatch-tryton
Project-URL: issues, https://bugs.tryton.org/hatch-tryton
Project-URL: repository, https://code.tryton.org/hatch-tryton
Author-email: Cédric Krier <cedric.krier@b2ck.com>
Maintainer-email: Tryton <foundation@tryton.org>
License-Expression: MIT
License-File: COPYRIGHT
License-File: LICENSE
Keywords: hatch,tryton
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Framework :: Hatch
Classifier: Framework :: Tryton
Classifier: Topic :: System :: Archiving :: Packaging
Requires-Python: >=3.9
Requires-Dist: hatchling
Description-Content-Type: text/x-rst

============
hatch-tryton
============

A ``hatchling`` plugin to manage Tryton dependencies.

Usage
=====

#. Include it as a plugin to your ``pyproject.toml``:

   .. code:: toml

      [build-system]
      requires = ['hatchling', 'hatch-tryton']
      build-backend = 'hatchling.build'

#. Mark your ``version``, ``dependencies``, ``optional-dependencies``,
   ``readme`` and ``authors`` fields as ``dynamic``:

   .. code:: toml

      [project]
      dynamic = ['version', 'dependencies', 'optional-dependencies', 'authors', 'readme']

#. And configure the plugin:

   .. code:: toml

      [tool.hatch.metadata.hooks.tryton]
      # Path to the ``tryton.cfg`` file
      config = 'tryton.cfg'

      # Dictionary mapping module names to their package prefixes
      prefixes = {}

      # List of dependencies that are not Tryton modules
      dependencies = []

      # List of dependencies that are specifically Tryton modules
      tryton_dependencies = []

      # Path to the README file
      readme = ''

      # Path to the copyright file
      copyright = ''

      [tool.hatch.metadata.hooks.tryton.optional-dependencies]
      # Add any optional non-Tryton dependencies here

      [tool.hatch.metadata.hooks.tryton.tryton-optional-dependencies]
      # Add any optional Tryton dependencies here

.. note::

   The ``depends`` in ``tryton.cfg`` are added automatically as dependencies.

   The ``extras_depend`` in ``tryton.cfg`` are added automatically as ``test``
   option dependencies.
