pyproject.toml

[project]
name = "khisto"
version = "0.3.0"
description = "Optimal histogram visualization using the Khiops algorithm"
readme = "README.md"
license = "BSD-3-Clause-Clear"
license-files = ["LICENSE"]
requires-python = ">=3.10"
dependencies = ["numpy>=2.0"]
authors = [
    {name = "Elouen Ginat", email = "elouen.ginat@orange.com"},
]
keywords = [
    "histogram",
    "binning",
    "optimal",
    "khiops",
    "statistics",
    "data-analysis",
    "density-estimation",
    "distribution",
    "numpy",
    "matplotlib",
    "visualization",
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "Intended Audience :: Science/Research",
    "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",
    "Topic :: Scientific/Engineering :: Mathematics",
    "Topic :: Scientific/Engineering :: Visualization",
    "Typing :: Typed",
]

[project.urls]
Homepage = "https://github.com/khiops/khisto-python"
Documentation = "https://khiops.github.io/khisto-python/"
Repository = "https://github.com/khiops/khisto-python"
Issues = "https://github.com/khiops/khisto-python/issues"
Changelog = "https://github.com/khiops/khisto-python/blob/main/CHANGELOG.md"

[tool.khiops]
khiops-version = "11.0.1-rc.1"

[project.optional-dependencies]
matplotlib = ["matplotlib>=3.8"]
all = ["matplotlib>=3.8"]

[dependency-groups]
test = [
    "pytest>=8.3",
    "pytest-xdist>=3.6",
    "pytest-cov>=6",
    "pytest-sugar>=1.0",
]
lint = [
    "pre-commit>=4.1",
    "pre-commit-hooks>=5.0",
    "ruff>=0.9",
]
docs = [
    "sphinx>=6.1",
    "furo>=2022.12.7",
    "numpydoc>=1.5",
    "sphinx-copybutton>=0.5",
    "sphinx-design>=0.6",
    "nbsphinx>=0.9",
    "pypandoc>=1.17",
    "ipykernel>=7",
    "matplotlib>=3.8",
]
dev = [
    {include-group = "test"},
    {include-group = "lint"},
    {include-group = "docs"},
    "tomli>=2.0.0; python_version < '3.11'" # TODO : Remove on Python 3.10 EOL
]

[build-system]
requires = ["scikit-build-core>=0.11.6", "ninja"]
build-backend = "scikit_build_core.build"

[tool.pytest.ini_options]
addopts = "-n 4 --cov --cov-report term-missing --durations=10"
testpaths = ["tests"]

[tool.bandit]
skips = ['B403', 'B301']

[tool.codespell]
skip = '*.ipynb,./src/verbascope/assets,./sandbox,./scripts,./build/doc,./CHANGELOG.md,./doc,./poetry.lock,./src/khiops'
ignore-words-list = "blocs, coo, hist, nd, sav, ser, recuse, nin, verbascope"
ignore-regex = 'https://([\w/\.])+'
quiet-level = 3

[tool.ruff]
# Group violations by containing file.
output-format = "grouped"
line-length = 88
indent-width = 4

# Enable fix by default
fix = true

# Exclude a variety of commonly ignored directories.
extend-exclude = ["scripts", "docs", "sandbox", ".github"]

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

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

[tool.ruff.lint]

# Allow fix for all enabled rules
fixable = ["ALL"]
unfixable = []
ignore = [
    "E402", # module level import not at top of file
]

[tool.scikit-build]
wheel.py-api = "py3"             # We specify full compatibility with all Python 3 releases
cmake.version = "CMakeLists.txt" # Read CMake minimal version from file
cmake.args = ["-G", "Ninja"]     # Generator specification and build configuration

# CMake variables
# Build khisto binary in Release mode for better performance, as it is not intended for debugging
cmake.define.CMAKE_BUILD_TYPE = "Release"
# Options
cmake.define.MPI = false
cmake.define.TESTING = false
cmake.define.BUILD_LEX_YACC = false
cmake.define.BUILD_JARS = false
cmake.define.GENERATE_VIEWS = false
cmake.define.C11 = true
ninja.make-fallback = false
build.targets = ["khisto"]      # Build only khisto
install.components = ["KHISTO"] # Only install KHISTO component in wheel

[tool.scikit-build.metadata.version]
provider = "scikit_build_core.metadata.regex"
input = "src/khisto/__init__.py"

[tool.cibuildwheel]
build = "cp310-*"
skip = "*musllinux*"       # Khiops does not compile when using musl as the C standard library
archs = "auto64"           # Do not build 32-bit wheels

# Install build-time dependencies in containers created by cibuildwheel
# This is compatible with Debian-like and Fedora-like distributions
[tool.cibuildwheel.linux]
before-all = [
    "apt-get install -y ninja-build || dnf install -y ninja-build"
]