pyproject.toml

[build-system]
requires = ["flit_core >=3.2,<4"]
build-backend = "flit_core.buildapi"

[project]
name="ansys-scade-python-wrapper"
version="2.0.dev0"
description="SCADE code generation target to produce a Python proxy to a SCADE application."
readme="README.rst"

# only 3.7, 3.10, or >= 3.12
requires-python = ">=3.7,!=3.8.*,!=3.9.*,!=3.11.*"
license = "MIT"
license-files = ["LICENSE"]
authors = [
    {name = "ANSYS, Inc.", email = "pyansys.core@ansys.com"},
]
maintainers = [
    {name = "ANSYS, Inc.", email = "pyansys.core@ansys.com"},
]
dependencies=[
    "importlib-metadata >= 1.0; python_version < '3.8'",
    "importlib-metadata >= 4.0; python_version >= '3.8'",
    "ansys-scade-apitools >= 0.5",
    "ansys-scade-wux >= 2.3.0",
]
classifiers=[
    "Development Status :: 4 - Beta",
    "Programming Language :: Python :: 3.7",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.12",
    "Operating System :: Microsoft :: Windows",
]
keywords=["Scade", "Wrapper", "Integration"]

[project.optional-dependencies]
build = [
    "build==1.4.4",
    "twine==6.2.0"
]
tests = [
    "pytest >= 8.3.4; python_version >= '3.8'",
    "pytest <= 7.4.4; python_version < '3.8'",
    "pytest-cov >= 6.0.0; python_version >= '3.8'",
    "pytest-cov <= 4.1.0; python_version < '3.8'",
]
doc = [
    "ansys-sphinx-theme[autoapi]==1.7.0; python_version >= '3.12'",
    "ansys-sphinx-theme[autoapi]==1.3.2; python_version <= '3.10'",
    "autodoc_pydantic==2.2.0",
    "numpydoc==1.9.0",
    "sphinx==9.1.0; python_version >= '3.12'",
    "sphinx==8.1.3; python_version <= '3.10'",
    "sphinxcontrib-globalsubs==1.1.0; python_version >= '3.12'",
    "sphinxcontrib-globalsubs==0.1.2; python_version <= '3.10'",
    "sphinxcontrib-httpdomain==1.8.1",
    "sphinx-copybutton==0.5.2",
    "sphinx-jinja==2.0.2",
    "sphinxnotes-strike==2.0; python_version >= '3.12'",
    "sphinxnotes-strike==1.2.1; python_version <= '3.10'",
]

[tool.flit.module]
name = "ansys.scade.python_wrapper"

[project.urls]
Source = "https://github.com/ansys/scade-python-wrapper"
Issues = "https://github.com/ansys/scade-python-wrapper/issues"
Discussions = "https://github.com/ansys/scade-python-wrapper/discussions"
Documentation = "https://python-wrapper.scade.docs.pyansys.com/"
Releases = "https://github.com/ansys/scade-python-wrapper/releases"
Homepage = "https://www.ansys.com/products/embedded-software/ansys-scade-suite"

[project.entry-points."ansys.scade.registry"]
srg = "ansys.scade.python_wrapper:srg"
register = "ansys.scade.python_wrapper.register:register"
unregister = "ansys.scade.python_wrapper.unregister:unregister"

[project.scripts]
ansys_scade_python_wrapper_swanpython = "ansys.scade.python_wrapper.swanpython:main"
# backward compatibility
register_ansys_scade_python_wrapper = "ansys.scade.python_wrapper.register:main"
unregister_ansys_scade_python_wrapper = "ansys.scade.python_wrapper.unregister:main"

[tool.ruff]
line-length = 99
lint.select = [
    "E",    # pycodestyle, see https://beta.ruff.rs/docs/rules/#pycodestyle-e-w
    "D",    # pydocstyle, see https://beta.ruff.rs/docs/rules/#pydocstyle-d
    "F",    # pyflakes, see https://beta.ruff.rs/docs/rules/#pyflakes-f
    "I",    # isort, see https://beta.ruff.rs/docs/rules/#isort-i
    "N",    # pep8-naming, see https://beta.ruff.rs/docs/rules/#pep8-naming-n
]
lint.ignore = [
    "D203",  # One blank line required before class docstring.
    "D204",  # One blank line required after class docstring.
    "D206",  # To ignore: conflict with the formatter
]
exclude = [
    # generated file
    "pydata.py",
]

# TODO: "preserve" leads to an error, although it is documented
# and used in other repositories
[tool.ruff.format]
quote-style = "single"

[tool.ruff.lint.isort]
combine-as-imports = true
force-sort-within-sections = true
known-first-party = ["ansys", "conftest", "test_utils"]

[tool.ruff.lint.pydocstyle]
convention = "numpy"

[tool.ruff.lint.per-file-ignores]
"tests/*.py" = ["D",]
# generated file
"src/ansys/scade/python-wrapper/pydata.py" = ["D101", "D102", "D103"]
# naming rules not applicable
"tools/BuildData/*.py" = ["N",]

[tool.coverage.run]
source = ["ansys.scade.python_wrapper"]

[tool.coverage.report]
show_missing = true

[tool.pytest.ini_options]
testpaths = "tests"
addopts = "-ra --cov=ansys.scade.python_wrapper --cov-report html:.cov/html --cov-branch --cov-report xml:.cov/xml --cov-report term -vv"

[tool.towncrier]
package = "ansys.scade.python_wrapper"
directory = "doc/changelog.d"
filename = "doc/source/changelog.rst"
start_string = ".. towncrier release notes start\n"
template = "doc/changelog.d/changelog_template.jinja"
title_format = "`{version} <https://github.com/ansys/scade-python-wrapper/releases/tag/v{version}>`_ - {project_date}"
issue_format = "`#{issue} <https://github.com/ansys/scade-python-wrapper/pull/{issue}>`_"

[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking"
showcontent = true

[[tool.towncrier.type]]
directory = "added"
name = "Added"
showcontent = true

[[tool.towncrier.type]]
directory = "fixed"
name = "Fixed"
showcontent = true

[[tool.towncrier.type]]
directory = "documentation"
name = "Documentation"
showcontent = true

[[tool.towncrier.type]]
directory = "dependencies"
name = "Dependencies"
showcontent = true

[[tool.towncrier.type]]
directory = "maintenance"
name = "Maintenance"
showcontent = true

[[tool.towncrier.type]]
directory = "miscellaneous"
name = "Miscellaneous"
showcontent = true

[[tool.towncrier.type]]
directory = "test"
name = "Test"
showcontent = true

[[tool.towncrier.type]]
directory = "changed"
name = "Changed"
showcontent = true