pyproject.toml

[project]
name = "exca"
readme = "README.md"
authors = [{name = "Meta FAIR"}]
requires-python = ">=3.10"
version = "0.1.1"

dependencies = [
  "numpy>=1.19",
  "pyyaml>=6.0",
  "pydantic>=2.5.0",
  "submitit>=1.5.1",
]

[project.urls]
  Source = "https://github.com/facebookresearch/exca"
  Tracker = "https://github.com/facebookresearch/exca/issues"

[project.optional-dependencies]
    dev = [
        # optional features
        "pandas>=2.2.2",
        "torch>=2.0.1",
        "mne>=1.4.0",
        "nibabel>=5.1.0",
        "pyarrow>=17.0.0",
        # Test
        "pytest>=7.4.0",
        "pytest-markdown-docs>=0.5.0",
        # Format
        "tqdm>=4.65.0",
        "black==24.3.0",
        "isort==5.12.0",
        "pre-commit>=3.0.0",
        # Linters
        "mypy>=1.11.0",
        "pylint>=2.13.9",
        "flake8",
        # typing stubs
        "pandas-stubs",
        "types-PyYAML",
        "types-setuptools",
        "types-tqdm",
        # documentation
        "sphinx>=7.4.7",
        # "sphinx_rtd_theme>=2.0.0",
        # "recommonmark>=0.7.1",
        # "autodocsumm>=0.2.12",
        "myst-parser>=3.0.1",
    ]

[tool.black]
line-length = 90
exclude = '''
/(
  | \.git
  | \.mypy_cache
)/
'''
force-exclude = '''
/(
   scratch
)\
'''

[tool.setuptools.packages.find]
where = ["."]  # list of folders that contain the packages (["."] by default)
include = ["exca*"]  # package names should match these glob patterns (["*"] by default)
exclude = []  # exclude packages matching these glob patterns (empty by default)
namespaces = false  # to disable scanning PEP 420 namespaces (true by default)

[tool.setuptools.package-data]
# not sufficient in editable mode: https://github.com/python/mypy/issues/13392
# still need to install with: pip install --config-settings editable_mode=strict -e .
"exca" = ["py.typed", ".pyi"]

[tool.isort]
profile = "black"
line_length = 90
skip_gitignore = true

[tool.pylint]
  [tool.pylint."MESSAGES CONTROL"]
  # disabled messages
  # * no-member has a lot of false positive, mypy does it better
  disable = """
      broad-except,
      fixme,
      invalid-name,
      logging-fstring-interpolation,
      missing-docstring,
      no-else-return,
      no-member,
      protected-access,
      too-few-public-methods,
      too-many-locals,
      too-many-statements,
      too-many-return-statements,
      too-many-branches,
      useless-import-alias,
      unspecified-encoding,
      use-dict-literal,
      useless-import-alias,
      import-outside-toplevel
  """
  [tool.pylint.DESIGN]
  max-args = 6

  [tool.pylint.FORMAT]
  max-line-length = "140"

  [tool.pylint.SIMILARITIES]
  ignore-imports = "yes"

[tool.mypy]
  plugins = ['pydantic.mypy']
  show_error_codes = true

[[tool.mypy.overrides]]
  module = ['pytest', 'setuptools', 'cloudpickle', 'mne', 'nibabel', 'neuralset', 'pyarrow']
  ignore_missing_imports = true
[[tool.mypy.overrides]]
  # some packages we do not install
  module = ['exca.dumperloader']
  disable_error_code = ['import-not-found', 'valid-type']

[tool.pydantic-mypy]
  init_forbid_extra = true
  init_typed = true
  warn_required_dynamic_aliases = true