pyproject.toml

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

[project]
name = "importnb"
description = "import jupyter notebooks as python modules and scripts."
readme = "README.md"
keywords = [
]
license = "BSD-3-Clause AND MPL-2.0"
license-files = { paths = ["LICENSE", "LICENSE-MPL-2.0"] }
authors = [{ name = "tonyfast", email = "tony.fast@gmail.com" }]
requires-python = ">=3.8"
classifiers = [
  "Development Status :: 4 - Beta",
  "Framework :: IPython",
  "Framework :: Jupyter",
  "License :: OSI Approved :: BSD License",
  "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
  "Natural Language :: English",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3 :: Only",
  "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",
]
dynamic = [
  "version",
] # uses hatch-vcs
dependencies = [
  'importlib-metadata>=4.8.3; python_version < "3.10"',
]
[project.optional-dependencies]
docs = [
  "mkdocs-jupyter",
  "mkdocs-material",
  "ruamel.yaml",
]
interactive = [
  "ipython",
]
tasks = [
  "doit",
  "tomli",
]
[project.urls]
Documentation = "https://github.com/deathbeds/importnb#readme"
Issues = "https://github.com/deathbeds/importnb/issues"
Source = "https://github.com/deathbeds/importnb"
[project.scripts]
importnb = "importnb.__main__:main"
[project.entry-points.importnb]
ipy = "importnb.loader:Notebook"
ipynb = "importnb.loader:Notebook"
json = "importnb.loaders:Json"
py = "importnb.loader:Loader"
toml = "importnb.loaders:Toml"
yaml = "importnb.loaders:Yaml"
yml = "importnb.loaders:Yaml"
[project.entry-points.pytest11]
importnb = "importnb.utils.pytest_importnb"

[tool.hatch.build.hooks.custom]
# we build a json grammar with each release because we fiend for line numbers
dependencies = ["lark"]

[tool.hatch.version]
# versioning
source = "vcs"

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

[tool.hatch.build.targets.sdist]
exclude = ["docs/coverage", "docs/*.png"]

[tool.hatch.envs.test]
# test matrix
dependencies = [
  "pytest",
  "pytest-cov",
  "doit",
  "tomli",
  "ruamel.yaml",
  "tomli_w",
]

[[tool.hatch.envs.test.matrix]]
version = ["stdlib", "interactive"]

[tool.hatch.envs.test.overrides]
matrix.version.features = [{ value = "interactive", if = ["interactive"] }]
matrix.version.dev-mode = [{ value = false, env = ["CI=true"] }]

[tool.hatch.envs.test.scripts]
cov = """
pytest --cov=importnb --cov-branch --cov-context=test --cov-report=html --cov-report=term-missing:skip-covered --no-cov-on-fail
"""
run = "pytest"

[tool.hatch.envs.released]
# test a release on test-pypi
dependencies = [
  "importnb",
  "IPython",
  "pytest",
  "pytest-cov",
  "doit",
  "tomli_w",
  "ruamel.yaml",
]

[tool.hatch.envs.released.scripts]
test = "pytest"

[tool.hatch.envs.released.env-vars]
PIP_INDEX_URL = "https://test.pypi.org/simple/"
PIP_EXTRA_INDEX_URL = "https://pypi.org/simple/"
PIP_PRE = "1"

[[tool.hatch.envs.released.matrix]]
version = ["interactive", "stdlib"]

[tool.hatch.envs.docs]
# documentation
features = ["docs"]

[tool.hatch.envs.docs.scripts]
build = "mkdocs build"
serve = "mkdocs serve"

[tool.hatch.envs.format]
skip-install = true
dependencies = [
  "ruff",
  "pyproject-fmt"
]

[tool.hatch.envs.format.scripts]
code = """
pyproject-fmt pyproject.toml
ruff --fix-only .
ruff format .
"""

[tool.ruff]
# formatting cause linting sucks
cache-dir = "build/.cache/ruff"
line-length = 100
extend-include = ["*.ipynb"]

[tool.ruff.lint]
isort.known-first-party = ["importnb"]
ignore = [
  "D203",
  "D213",
  "COM812",
  "ISC001",
]
select = [
  "A",
  "ANN",
  "ARG",
  "B",
  "BLE",
  "C4",
  "C90",
  "COM",
  "D",
  "DJ",
  "DTZ",
  "E",
  "EM",
  "ERA",
  "EXE",
  "F",
  "FBT",
  "G",
  "I",
  "ICN",
  "INP",
  "ISC",
  "N",
  "NPY",
  "PD",
  "PGH",
  "PIE",
  "PL",
  "PT",
  "PTH",
  "PYI",
  "Q",
  "RET",
  "RSE",
  "RUF",
  "S",
  "SIM",
  "SLF",
  "T10",
  "T20",
  "TCH",
  "TID",
  "TRY",
  "UP",
  "W",
  "YTT",
]
[tool.ruff.lint.per-file-ignores]
"test_cli.py" = ["D415", "D207", "D208"]

[tool.pytest.ini_options]
cache_dir = "build/.cache/pytest"
addopts = [
  "-vv",
  "--tb=long",
  "--color=yes",
  "-ppytester",
]
filterwarnings = [
  "error",
]

[tool.coverage.run]
data_file = "build/.coverage"
[tool.coverage.report]
omit = ["_json_parser.py"]
[tool.coverage.html]
directory = "docs/coverage"
show_contexts = true