pyproject.toml

[build-system]
requires = ["setuptools>=64", "wheel"]
build-backend = "setuptools.build_meta"

[project]
dynamic = ["version"]
name = "eegdash"
authors = [
  { name = "Bruno Aristimunha",   email = "b.aristimunha@gmail.com" },
  { name = "Aviv Dotan",          email = "avivdot@bgu.post.ac.il" },
  { name = "Pierre Guetschel",    email = "pierre.guetschel@donders.ru.nl" },
  { name = "Dung Truong",         email = "dt.young112@gmail.com" },
  { name = "Kuntal Kokate" },
  { name = "Aman Jaiswal",        email = "aman.jaiswal.1503@gmail.com" },
  { name = "Amitrava Majumdar" },
  { name = "Seyed Yahya Shirazi" },
  { name = "Oren Shriki",         email = "shrikio@bgu.ac.il" },
  { name = "Arnaud Delorme",      email = "adelorme@ucsd.edu" },
]
description     = "EEG-DaSh: an open data, tool, and compute resource — a Python library and catalog for 700+ BIDS-first EEG, MEG, fNIRS, EMG, and iEEG datasets, ML-ready via PyTorch"
readme          = "README.md"
license         = "BSD-3-Clause"
requires-python = ">=3.11"
keywords        = [
    "eeg",
    "electroencephalography",
    "brain-computer-interface",
    "bci",
    "neuroscience",
    "machine-learning",
    "deep-learning",
    "bids",
    "mne",
    "signal-processing",
    "feature-extraction",
    "dataset",
]

classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Healthcare Industry",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: Scientific/Engineering :: Bio-Informatics",
    "Topic :: Scientific/Engineering :: Medical Science Apps.",
    "Topic :: Scientific/Engineering :: Information Analysis",
]

dependencies = [
  "braindecode[hub]>=1.4.0",
  "eeglabio",
  "mne>=1.11.0",
  "mne_bids>=0.19.0",
  # Official NEMAR client: owns dataset-id validation (nm*/on*),
  # manifest fetching, BIDS-path → annex-key mapping, and streaming
  # downloads. eegdash delegates the data.nemar.org safety net to it
  # instead of duplicating those primitives. >=0.2.0 keeps datalad and
  # git-annex as opt-in extras (``nemar-py[datalad]``) so the runtime
  # install stays lean.
  "nemar-py>=0.2.0",
  "pandas",
  "pydantic",
  "pymatreader",
  "requests>=2.25.0",
  "rich",
  # boto3 (sync SDK) instead of s3fs: s3fs drags in aiobotocore, which hard-pins
  # botocore and breaks any env that also needs boto3. See issue #397.
  "boto3>=1.34",
  "tqdm",
  "eegdash[features]",
]

[tool.uv]
required-environments = [
  "sys_platform == 'darwin' and platform_machine == 'x86_64'",  # Intel Mac
  "sys_platform == 'darwin' and platform_machine == 'arm64'",   # Apple Silicon Mac (M1/M2/M3)
  "sys_platform == 'linux' and platform_machine == 'x86_64'",   # Linux 64-bit
  "sys_platform == 'win32' and platform_machine == 'AMD64'"     # Windows 64-bit
]

[project.urls]
Homepage      = "https://eegdash.org"
Documentation = "https://eegdash.org"
Repository    = "https://github.com/eegdash/EEGDash"
Source        = "https://github.com/eegdash/EEGDash"
Issues        = "https://github.com/eegdash/EEGDash/issues"
"Bug Tracker" = "https://github.com/eegdash/EEGDash/issues"
Changelog     = "https://github.com/eegdash/EEGDash/releases"
Discussions   = "https://github.com/eegdash/EEGDash/discussions"
Chat          = "https://discord.gg/8jd7nVKwsc"


[project.optional-dependencies]
features = [
  # Floor numba so the resolver can't backtrack to ancient releases (e.g.
  # numba 0.53.1 → llvmlite 0.36, which won't build on Python >=3.10). When a
  # co-installed package pushes numpy past numba's ceiling, the floor forces
  # numpy down to numba's supported range instead. See eegdash/EEGDash#170.
  "numba>=0.60,<0.61; sys_platform == 'darwin' and platform_machine == 'x86_64'",
  "numba>=0.61;       sys_platform != 'darwin' or platform_machine != 'x86_64'",
  "safetensors",
]
tests = [
    'pytest',
    'pytest-cov',
    'pytest-benchmark',
    'plotly',
    'moabb',
    # tests/unit_tests/test_annex_key_utils.py + tests/unit_tests/test_digest_parsers.py
    # import from scripts/ingestions/_file_utils.py + 3_digest.py, which require
    # these at module top after the PEP-8 import-lift sweep.
    'tenacity>=8',
    'pydantic-settings>=2',
    # Enforces the Croissant 1.0 descriptor validity gate
    # (tests/unit_tests/test_croissant_export.py). Optional: the gate skips
    # when absent, runs the MLCommons validator when present.
    'mlcroissant',
]
dev = [
  "pre-commit",
]

docs = [
  "sphinx",
  "sphinx_design",
  "sphinx_gallery",
  "pydata-sphinx-theme",
  "sphinx-copybutton",
  "sphinx-sitemap",
  "sphinxext-opengraph",
  "sphinx-markdown-builder",
  "sphinxcontrib-bibtex",
  "numpydoc",
  "lightgbm",
  "plotly",
  "seaborn",
  "moabb",
  "neuralfetch>=0.2",
  "neuralset>=0.2",
  "eegprep",
  # Validate the Croissant 1.0 descriptors emitted alongside the docs build.
  "mlcroissant",
]

digestion = [
  "pybids",
  "gql[requests]",
  "requests_toolbelt",
  "beautifulsoup4",
  "python-dotenv",
  "selenium",
  "httpx",
  "tenacity",
  "hishel",
  "pydantic>=2",
  "pydantic-settings>=2",
  "PyGithub>=2",
]

all = [
  "eegdash[docs]",
  "eegdash[dev]",
  "eegdash[tests]",
  "eegdash[digestion]",
]

[tool.setuptools]
py-modules = []
include-package-data = true

[tool.setuptools.dynamic]
version = {attr = "eegdash.__version__"}

[tool.setuptools.packages.find]
where      = ["."]
include    = ["eegdash*"]
exclude    = []
namespaces = false

[tool.setuptools.package-data]
"eegdash" = ["dataset_summary.csv"]
"eegdash.dataset" = ["dataset_summary.csv"]

[tool.ruff]
line-length = 88
target-version = "py311"

[tool.ruff.lint]
ignore-init-module-imports = true
select = ["E", "W", "F", "D", "I", "NPY201", "PLC0415"]
ignore = ["E402", "E501", "D100", "D101", "D102", "D103", "D104", "D105", "D107", "D205", "D400", "D415", "D417", "F403", "D401", "E741", "E722", "D419"]

[tool.ruff.lint.per-file-ignores]
"examples/*" = ["I"]
# PLC0415 grace list — legacy lazy imports for optional deps + circular-
# import guards. Each entry is a candidate for cleanup in a follow-up; the
# rule still fires on any NEW function-scoped import in untouched files.
"eegdash/__init__.py" = ["PLC0415"]
"eegdash/api.py" = ["PLC0415"]
"eegdash/dataset/base.py" = ["PLC0415"]
"eegdash/dataset/dataset.py" = ["PLC0415"]
"eegdash/dataset/io.py" = ["PLC0415"]
"eegdash/dataset/registry.py" = ["PLC0415"]
"eegdash/features/extractors.py" = ["PLC0415"]
"eegdash/features/serialization.py" = ["PLC0415"]
"eegdash/local_bids.py" = ["PLC0415"]
"eegdash/viz/identity.py" = ["PLC0415"]

[tool.ruff.lint.isort]
known-first-party = ["eegdash", "braindecode"]
section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]

[tool.pytest.ini_options]
testpaths        = ["tests"]
python_files     = ["test_*.py", "*_test.py"]
python_functions = ["test_*"]
markers = [
    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
    "benchmark: marks tests as benchmarks (run with '--benchmark-enable')",
    "network: marks tests that require network/S3 access (deselect with '-m \"not network\"')",
]
addopts = "-m 'not slow and not benchmark and not network' -ra --durations=10"