pyproject.toml

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "antares-web-installer"
dynamic = ["version"]
description = 'Installation application for Antares Web Desktop'
readme = "README.md"
requires-python = ">=3.8"
license = "MIT"
keywords = ["antares", "installation", "web", "desktop", "setup", "windows", "ubuntu"]
authors = [
    { name = "Laurent LAPORTE", email = "laurent.laporte.pro@gmail.com" },
    { name = "Maurane GLAUDE", email = "maurane.glaude@gmail.com" },
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: Implementation :: CPython",
    "Programming Language :: Python :: Implementation :: PyPy",
]

dependencies = [
    'click<8.2',
    'psutil<5.10',
    'pyyaml<6.1',
    'pywin32<=306; sys_platform == "win32"',
    'requests',
    'platformdirs<=4.2.2',
    'uvicorn',
]

[project.urls]
Documentation = "https://github.com/AntaresSimulatorTeam/antares-web-installer#readme"
Issues = "https://github.com/AntaresSimulatorTeam/antares-web-installer/issues"
Source = "https://github.com/AntaresSimulatorTeam/antares-web-installer"

[tool.hatch.version]
path = "src/antares_web_installer/__about__.py"
attr = "__version__"

[tool.hatch.envs.default]
dependencies = [
    "coverage[toml]>=6.5",
    "pytest<8",
    "pytest-datadir",
    "fastapi",
    "pyinstaller",
    "requests",
    "platformdirs==4.2.2",
    "uvicorn",
]
[tool.hatch.envs.default.scripts]
test = "pytest {args:tests} --basetemp=target"
test-cov = "coverage run -m pytest {args:tests}"
cov-report = [
    "- coverage combine",
    "coverage report --show-missing",
    "coverage html",
]
cov = [
    "test-cov",
    "cov-report",
]

[[tool.hatch.envs.all.matrix]]
python = ["3.8", "3.9", "3.10", "3.11", "3.12"]

[tool.hatch.envs.types]
dependencies = [
    "pytest<8",
    "mypy>=1.0.0",
    "fastapi",
    "pyinstaller",
    "requests"
]
[tool.hatch.envs.types.scripts]
check = "mypy --install-types --non-interactive {args:src/antares_web_installer tests}"

[tool.hatch.envs.docs]
detached = true
dependencies = ["mkdocs"]

[tool.hatch.envs.docs.scripts]
build = "mkdocs build -f mkdocs.yml {args}"
serve = "mkdocs serve -f mkdocs.yml {args}"
gh-deploy = "mkdocs gh-deploy -f mkdocs.yml {args}"

[tool.hatch.envs.pyinstaller]
dependencies = ["pyinstaller"]

[tool.hatch.envs.pyinstaller.scripts]
build_cli = 'pyinstaller --onefile src/antares_web_installer/cli/__main__.py --hidden-import antares_web_installer.shortcuts._linux_shell --hidden-import antares_web_installer.shortcuts._win32_shell --noconsole --name {args:AntaresWebInstallerCLI}'
build_gui = 'pyinstaller --onefile src/antares_web_installer/gui/__main__.py --hidden-import antares_web_installer.shortcuts._linux_shell --hidden-import antares_web_installer.shortcuts._win32_shell --noconsole --name {args:AntaresWebInstaller}'

[tool.mypy]
mypy_path = 'src'
exclude = [
    # Exclude test resources
    '^tests/config/test_config_2_15$',
    '^tests/samples.*$',
    '^tests/results/*$'
]

[tool.coverage.run]
source_pkgs = ["antares_web_installer", "tests"]
branch = true
parallel = true
omit = [
    "src/antares_web_installer/__about__.py",
]

[tool.coverage.paths]
antares_web_installer = ["src/antares_web_installer", "*/antares-web-installer/src/antares_web_installer"]
tests = ["tests", "*/antares-web-installer/tests"]

[tool.coverage.report]
exclude_lines = [
    "no cov",
    "if __name__ == .__main__.:",
    "if TYPE_CHECKING:",
]

[tool.black]
target-version = ["py38"]
line-length = 120

[tool.isort]
profile = "black"
line_length = 120
src_paths = ["src", "tests"]
skip_gitignore = true

[tool.ruff]
# Exclude a variety of commonly ignored directories.
exclude = [
    ".bzr",
    ".direnv",
    ".eggs",
    ".git",
    ".git-rewrite",
    ".hg",
    ".mypy_cache",
    ".nox",
    ".pants.d",
    ".pytype",
    ".ruff_cache",
    ".svn",
    ".tox",
    ".venv",
    "__pypackages__",
    "_build",
    "buck-out",
    "build",
    "dist",
    "node_modules",
    "venv",
]

# Same as Black.
line-length = 120
indent-width = 4

# Assume Python 3.8
target-version = "py38"

[tool.ruff.lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
# McCabe complexity (`C901`) by default.
select = ["E4", "E7", "E9", "F"]
ignore = []

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

[tool.ruff.format]
# Like Black, use double quotes for strings.
quote-style = "double"

# Like Black, indent with spaces, rather than tabs.
indent-style = "space"

# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false

# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"

# Enable auto-formatting of code examples in docstrings. Markdown,
# reStructuredText code/literal blocks and doctests are all supported.
#
# This is currently disabled by default, but it is planned for this
# to be opt-out in the future.
docstring-code-format = true

# Set the line length limit used when formatting code snippets in
# docstrings.
#
# This only has an effect when the `docstring-code-format` setting is
# enabled.
docstring-code-line-length = "dynamic"