pyproject.toml

[build-system]
requires = ["hatchling", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name =  "fury"
description = "FURY - Free Unified Rendering in pYthon. A free and open-source software library for Scientific Visualization and 3D animations"
readme = "README.md"
requires-python = ">=3.10"
license.file="LICENSE"
keywords = ["Scientific Visualization", "shaders", "animation", "simulation",
            "Physically based rendering", "3D", "3D rendering", "networks",
            "physics engine", "physics", "simulation", "visualization"]
authors = [
    {name = "Eleftherios Garyfallidis", email = "fury@python.org"},
    {name = "Serge Koudoro", email = "fury@python.org"},
    {name = "Maharshi Gor", email = "fury@python.org"},
    {name = "Javier Guaje", email = "fury@python.org"},
    {name = "Marc-Alexandre Côté", email = "fury@python.org"},
    {name = "Soham Biswas", email = "fury@python.org"},
    {name = "David Reagan", email = "fury@python.org"},
    {name = "Nasim Anousheh", email = "fury@python.org"},
    {name = "Filipi Silva", email = "fury@python.org"},
    {name = "Geoffrey Fox", email = "fury@python.org"},
]
maintainers = [
    {name = "FURY Developers", email = "fury@python.org"},
    ]

classifiers = [
	"Natural Language :: English",
    "Development Status :: 4 - Beta",
    "Environment :: Console",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering",
]

dependencies = [
    "numpy>=2.0",
    "scipy>=1.13.0",
    "pillow>=10.4.0",
    "packaging>=23.0",
    "lazy_loader>=0.4",
    "pygfx>=0.16.0",
    "glfw>=2.7.0",
    "aiohttp"
]

dynamic = ["version"]

[project.urls]
Documentation = "https://fury.gl"
Source = "https://github.com/fury-gl/fury"
Tracker = "https://github.com/fury-gl/fury/issues"

[project.optional-dependencies]

all = ["fury[optional, dev, doc, style, typing, test]"]
window = ["PySide6", "jupyter-rfb", "imgui_bundle; python_version >= \"3.12\""]
plot = ["matplotlib>=3.9.0"]
medical = ["dipy", "nibabel"]
compute = ["numba"]
optional = ["fury[window, plot, medical, compute]"]
dev = [
    "gitpython",
    "twine",
    "build",
    "fury[style, typing, test]",
    ]
doc = [
    "numpydoc",
    "sphinx >=6.1.2,<9.0.0",
    "ablog >=0.11.1",
    "texext",
    "tomli; python_version < \"3.11\"",
    "sphinx-copybutton",
    "sphinx-gallery>=0.10.0",
    "pydata-sphinx-theme==0.15.2",
    "fury[window, plot, medical]",
    ]
style = ["ruff", "pre-commit"]
typing = ["mypy", "types-Pillow", "data-science-types"]
test = [
    "coverage",
    "pytest !=5.3.4",
    "pytest-cov",
    "pytest-doctestplus",
    ]

[tool.hatch.build.targets.sdist]
exclude = [".git_archival.txt"]

[tool.hatch.build.targets.wheel]
packages = ["fury",]
exclude = []

[tool.hatch.version]
source = "vcs"
raw-options = { version_scheme = "release-branch-semver" }

[tool.hatch.build.hooks.vcs]
version-file = "fury/_version.py"

[tool.mypy]
python_version = "3.11"
ignore_missing_imports = "True"
exclude = [
  "/tests",
]

[tool.coverage.run]
branch = true

[tool.coverage.report]
fail_under = 100

[tool.pytest.ini_options]
filterwarnings = [
    "ignore:.*You do not have Matplotlib installed.*:UserWarning",
    "ignore:We'll no longer accept the way you call the.*function:UserWarning:.*doctest",
    "ignore:.*There is no current event loop.*:DeprecationWarning",
    # This is due to the Qt deprecation warnings in RenderCanvas
    "ignore:.*ApplicationAttribute.AA_EnableHighDpiScaling.*:DeprecationWarning"
]
# addopts = "--cov --cov-report html --cov-report term-missing --cov-fail-under 95"

[tool.codespell]
skip = '*.po,*.ts,*.html,./docs/build,./.mypy_cache,./build,./dist,.git,*.pdf,*.svg,*.bib'
count = ''
quiet-level = 3

[tool.numpydoc_validation]
checks = [
    "all",   # report on all checks, except the below
    "EX01",
    "SA01", # no see also
    "SA04",  # no description in See Also
    "ES01", # no extended summary
    "GL01", # Docstring should start in the line immediately after the quotes
    "GL02", # Closing quotes on own line (doesn't work on Python 3.13 anyway)
]
# remember to use single quotes for regex in TOML
exclude = [  # don't report on objects that match any of these regex
    '\.undocumented_method$',
    '\.__repr__$',
]