Upgrade to pyproject using hatchling as build-system

This commit is contained in:
Cédric Krier
2026-03-21 18:46:34 +01:00
parent d6dc19b523
commit e15c0b7d7a
1590 changed files with 17346 additions and 38132 deletions
@@ -1,4 +1,4 @@
Copyright (C) {% now 'local', '%Y' %} {{ cookiecutter.fullname }}
Copyright (C) {% now 'local', '%Y' %} {{ cookiecutter.author }}{% if cookiecutter.author_email %} <{{ cookiecutter.author_email }}>{% endif %}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@@ -17,8 +17,8 @@ else:
def get_info():
import configparser
import json
import subprocess
import sys
module_dir = os.path.dirname(os.path.dirname(__file__))
@@ -26,17 +26,15 @@ def get_info():
config.read_file(open(os.path.join(module_dir, 'tryton.cfg')))
info = dict(config.items('tryton'))
result = subprocess.run(
[sys.executable, 'setup.py', '--name', '--description'],
stdout=subprocess.PIPE, check=True, cwd=module_dir)
info['name'], info['description'] = (
result.stdout.decode('utf-8').strip().splitlines())
result = subprocess.run(
[sys.executable, 'setup.py', '--version'],
stdout=subprocess.PIPE, check=True, cwd=module_dir)
version = result.stdout.decode('utf-8').strip()
major_version, minor_version, _ = version.split('.', 2)
metadata_cmd = 'python -m build --quiet --metadata'
if os.environ.get('DOC_NO_ISOLATION'):
metadata_cmd += ' --no-isolation'
metadata = subprocess.check_output(
metadata_cmd, shell=True, encoding='utf-8', cwd=module_dir).strip()
metadata = json.loads(metadata)
info['name'] = metadata['name']
info['description'] = metadata['summary']
major_version, minor_version, _ = metadata['version'].split('.', 2)
major_version = int(major_version)
minor_version = int(minor_version)
if minor_version % 2:
@@ -1,2 +1,3 @@
build
sphinx_book_theme
sphinx_copybutton
@@ -0,0 +1,89 @@
[build-system]
requires = ['hatchling >= 1', 'hatch-tryton']
build-backend = 'hatchling.build'
[project]
name = '{{ cookiecutter.package_name }}'
dynamic = ['version', 'dependencies', 'optional-dependencies', 'authors', 'readme']
requires-python = '>=3.9'
maintainers = [
{%- if cookiecutter.prefix %}
{name = "{{ cookiecutter.author }}", email = "{{ cookiecutter.author_email }}"},
{%- else %}
{name = "Tryton", email = "foundation@tryton.org"},
{%- endif %}
]
description = "{{ cookiecutter.description }}"
license = 'GPL-3.0-or-later'
license-files = ['LICENSE', 'icons/LICENSE', 'COPYRIGHT']
keywords = {{ cookiecutter.keywords.split() | tojson }}
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Plugins",
"Framework :: Tryton",
"Topic :: Office/Business",
{%- if cookiecutter.module_name.startswith('account') or cookiecutter.module_name.startswith('analytic_account')%}
"Topic :: Office/Business :: Financial :: Accounting",
{%- endif %}
{%- if cookiecutter.module_name.startswith('sale') %}
"Topic :: Office/Business :: Financial :: Point-Of-Sale",
{%- endif %}
"Topic :: Software Development :: Libraries :: Python Modules",
]
[project.entry-points.'trytond.modules']
{%- if cookiecutter.prefix %}
{{ cookiecutter.module_name }} = '{{ cookiecutter.package_name }}'
{%- else %}
{{ cookiecutter.module_name }} = 'trytond.modules.{{ cookiecutter.module_name }}'
{%- endif %}
[project.urls]
{%- if not cookiecutter.prefix %}
homepage = "https://www.tryton.org/"
documentation = "https://docs.tryton.org/modules-{{ cookiecutter.module_name|replace('_', '-') }}/"
changelog = "https://docs.tryton.org/modules-{{ cookiecutter.module_name|replace('_', '-') }}/releases.html"
forum = "https://www.tryton.org/forum"
issues = "https://bugs.tryton.org/tryton"
repository = "https://code.tryton.org/tryton"
funding = "https://www.tryton.org/donate"
{%- endif %}
[tool.hatch.build]
include = [
'**/tryton.cfg',
'**/*.py',
'**/*.xml',
'view/**/*.xml',
'locale/**/*.po',
'**/*.fodt',
'icons/**/*.svg',
'tests/**/*.rst',
'tests/**/*.json',
]
exclude = ['doc']
{%- if cookiecutter.prefix %}
dev-mode-dirs = ["."]
{%- endif %}
[tool.hatch.build.targets.wheel.sources]
{%- if cookiecutter.prefix %}
"" = "{{ cookiecutter.module_name }}"
{%- else %}
"" = "trytond/modules/{{ cookiecutter.module_name }}"
{%- endif %}
[tool.hatch.metadata.hooks.tryton]
{%- if cookiecutter.prefix %}
prefix = {}
{%- endif %}
dependencies = []
copyright = 'COPYRIGHT'
readme = 'README.rst'
[tool.hatch.metadata.hooks.tryton.tryton-optional-dependencies]
{%- if cookiecutter.test_with_scenario %}
test = ['proteus']
{%- else %}
test = []
{%- endif %}
@@ -1,149 +0,0 @@
#!/usr/bin/env python3
{% if not cookiecutter.prefix -%}
# This file is part of Tryton. The COPYRIGHT file at the top level of
# this repository contains the full copyright notices and license terms.
{% endif -%}
import io
import os
import re
from configparser import ConfigParser
from setuptools import find_packages, setup
{%- if cookiecutter.prefix %}
MODULE2PREFIX = {}
{%- endif %}
def read(fname):
content = io.open(
os.path.join(os.path.dirname(__file__), fname),
'r', encoding='utf-8').read()
content = re.sub(
r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content)
return content
def get_require_version(name):
require = '%s >= %s.%s, < %s.%s'
require %= (name, major_version, minor_version,
major_version, minor_version + 1)
return require
config = ConfigParser()
config.read_file(open(os.path.join(os.path.dirname(__file__), 'tryton.cfg')))
info = dict(config.items('tryton'))
for key in ('depends', 'extras_depend', 'xml'):
if key in info:
info[key] = info[key].strip().splitlines()
version = info.get('version', '0.0.1')
major_version, minor_version, _ = version.split('.', 2)
major_version = int(major_version)
minor_version = int(minor_version)
name = '{{ cookiecutter.package_name }}'
{% if not cookiecutter.prefix %}
if minor_version % 2:
download_url = ''
else:
download_url = 'http://downloads.tryton.org/%s.%s/' % (
major_version, minor_version)
{% endif %}
requires = []
for dep in info.get('depends', []):
if not re.match(r'(ir|res)(\W|$)', dep):
{%- if not cookiecutter.prefix %}
requires.append(get_require_version('trytond_%s' % dep))
{%- else %}
prefix = MODULE2PREFIX.get(dep, 'trytond')
requires.append(get_require_version('%s_%s' % (prefix, dep)))
{%- endif %}
requires.append(get_require_version('trytond'))
{% if cookiecutter.test_with_scenario -%}
tests_require = [get_require_version('proteus')]
{%- else -%}
tests_require = []
{%- endif %}
setup(name=name,
version=version,
description='{{ cookiecutter.description }}',
long_description=read('README.rst'),
author='{{ cookiecutter.author }}',
author_email='{{ cookiecutter.author_email }}',
url='{{ cookiecutter.url }}',
{%- if not cookiecutter.prefix %}
download_url=download_url,
project_urls={
"Bug Tracker": 'https://bugs.tryton.org/',
"Documentation": 'https://docs.tryton.org/latest/modules-{{ cookiecutter.module_name|replace('_', '-') }}',
"Forum": 'https://www.tryton.org/forum',
"Source Code": 'https://code.tryton.org/tryton',
},
{%- endif %}
keywords='{{ cookiecutter.keywords }}',
package_dir={'trytond.modules.{{ cookiecutter.module_name }}': '.'},
packages=(
['trytond.modules.{{ cookiecutter.module_name }}']
+ ['trytond.modules.{{ cookiecutter.module_name }}.%s' % p
for p in find_packages()]
),
package_data={
'trytond.modules.{{ cookiecutter.module_name }}': (info.get('xml', [])
+ ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt',
'icons/*.svg', 'tests/*.rst', 'tests/*.json']),
},
classifiers=[
'Development Status :: 5 - Production/Stable',
'Environment :: Plugins',
'Framework :: Tryton',
'Intended Audience :: Developers',
'Intended Audience :: Financial and Insurance Industry',
'Intended Audience :: Legal Industry',
'License :: OSI Approved :: '
'GNU General Public License v3 or later (GPLv3+)',
'Natural Language :: Bulgarian',
'Natural Language :: Catalan',
'Natural Language :: Chinese (Simplified)',
'Natural Language :: Czech',
'Natural Language :: Dutch',
'Natural Language :: English',
'Natural Language :: Finnish',
'Natural Language :: French',
'Natural Language :: German',
'Natural Language :: Hungarian',
'Natural Language :: Indonesian',
'Natural Language :: Italian',
'Natural Language :: Persian',
'Natural Language :: Polish',
'Natural Language :: Portuguese (Brazilian)',
'Natural Language :: Romanian',
'Natural Language :: Russian',
'Natural Language :: Slovenian',
'Natural Language :: Spanish',
'Natural Language :: Turkish',
'Natural Language :: Ukrainian',
'Operating System :: OS Independent',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
'Programming Language :: Python :: 3.12',
'Programming Language :: Python :: 3.13',
'Programming Language :: Python :: Implementation :: CPython',
'Topic :: Office/Business',
],
license='GPL-3',
python_requires='>=3.9',
install_requires=requires,
extras_require={
'test': tests_require,
},
zip_safe=False,
entry_points="""
[trytond.modules]
{{ cookiecutter.module_name }} = trytond.modules.{{ cookiecutter.module_name }}
""", # noqa: E501
)
@@ -2,10 +2,14 @@
envlist = {py39,py310,py311,py312,py313}-{sqlite,postgresql}
[testenv]
usedevelop = true
changedir = {toxworkdir}
extras = test
commands =
coverage run --omit=*/tests/* -m xmlrunner discover -s tests {posargs}
{%- if cookiecutter.prefix %}
coverage run --source={{ cookiecutter.module_name }} --omit=*/tests/* -m xmlrunner discover -s {{ cookiecutter.module_name }} {posargs}
{%- else %}
coverage run --source=trytond.modules.{{ cookiecutter.module_name }} --omit=*/tests/* -m xmlrunner discover -s trytond.modules.{{ cookiecutter.module_name }} {posargs}
{%- endif %}
commands_post =
coverage report
coverage xml