pyproject.toml

[build-system]
requires = ["flit_core >=3.11,<4"]
build-backend = "flit_core.buildapi"

[project]
name = "myst-nb"
dynamic = ["version"]
description = "A Jupyter Notebook Sphinx reader built on top of the MyST markdown parser."
authors = [{name = "ExecutableBookProject", email = "chrisj_sewell@hotmail.com"}]
maintainers = [{name = "Angus Hollands", email = "goosey15@gmail.com"}]
readme = "README.md"
license = "BSD-3-Clause"
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Framework :: Sphinx :: Extension",
    "Intended Audience :: Developers",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Programming Language :: Python :: Implementation :: CPython",
    "Programming Language :: Python :: Implementation :: PyPy",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Text Processing :: Markup",
]
keywords = [
    "markdown",
    "lexer",
    "parser",
    "jupyter",
    "docutils",
    "sphinx",
]
requires-python = ">=3.10"
dependencies = [
    "importlib_metadata",
    "ipython",
    "jupyter-cache>=0.5",
    "nbclient",
    "myst-parser>=1.0.0",
    "nbformat>=5.0",
    "pyyaml",
    "sphinx>=5",  # If we get bugs for older versions, just pin this higher
    "typing-extensions",
    # ipykernel is not a requirement of the library,
    # but is a common requirement for users (registers the python3 kernel)
    "ipykernel",
]

[project.urls]
Homepage = "https://github.com/executablebooks/myst-nb"
Documentation = "https://myst-nb.readthedocs.io"

[project.entry-points."myst_nb.renderers"]
default = "myst_nb.core.render:NbElementRenderer"

[project.entry-points."myst_nb.mime_renderers"]
example = "myst_nb.core.render:ExampleMimeRenderPlugin"

[project.entry-points."pygments.lexers"]
myst-ansi = "myst_nb.core.lexers:AnsiColorLexer"
ipythontb = "myst_nb.core.lexers:IPythonTracebackLexer"

[project.entry-points."jcache.readers"]
myst_nb_md = "myst_nb.core.read:myst_nb_reader_plugin"

[project.optional-dependencies]
code_style = ["pre-commit"]
rtd = [
    "alabaster",
    "altair",
    "bokeh",
    "coconut>=1.4.3",
    "ipykernel>=5.5",
    "ipywidgets",
    "jupytext>=1.11.2",
    "matplotlib",
    "numpy",
    "pandas",
    "plotly",
    "sphinx-book-theme>=0.3",
    "sphinx-copybutton",
    "sphinx-design",
    "sphinxcontrib-bibtex",
    "sympy",
    "sphinx-autodoc-typehints",
]
testing = [
    "coverage>=6.4",
    "beautifulsoup4",
    "ipykernel>=5.5",
    # for issue with 8.1.0 see https://github.com/ipython/ipython/issues/13554
    "ipython!=8.1.0",
    "ipywidgets>=8",
    "jupytext>=1.11.2",
    # Matplotlib outputs are sensitive to the matplotlib version
    "matplotlib==3.10.7",
    "nbdime",
    "numpy",
    "pandas",
    "pyarrow",
    "pytest",
    "pytest-cov>=3",
    "pytest-regressions",
    "pytest-param-files",
    "sympy>=1.10.1",
]

[project.scripts]
mystnb-quickstart = "myst_nb.cli:quickstart"
mystnb-to-jupyter = "myst_nb.cli:md_to_nb"
mystnb-docutils-html = "myst_nb.docutils_:cli_html"
mystnb-docutils-html5 = "myst_nb.docutils_:cli_html5"
mystnb-docutils-latex = "myst_nb.docutils_:cli_latex"
mystnb-docutils-xml = "myst_nb.docutils_:cli_xml"
mystnb-docutils-pseudoxml = "myst_nb.docutils_:cli_pseudoxml"

[tool.flit.module]
name = "myst_nb"

[tool.flit.sdist]
exclude = [
    "docs/",
    "tests/",
]

[tool.mypy]
show_error_codes = true
check_untyped_defs = true
strict_equality = true
no_implicit_optional = true
ignore_missing_imports = true
warn_unused_ignores = true

[[tool.mypy.overrides]]
module = ["myst_nb.*"]
# can only follow these imports when more of the code is typed
follow_imports = "skip"

[[tool.mypy.overrides]]
module = ["docutils.*", "nbformat.*", "jupyter_cache.*", "IPython.*", "pygments.*"]
ignore_missing_imports = true

[tool.ruff.lint]
ignore = [
    "E203",    # Whitespace before punctuation
]

[tool.ruff.lint.extend-per-file-ignores]
"tests/*/*ipynb" = ["E402"]   # module-import-not-at-top-of-file

[tool.ruff.lint.isort]
force-sort-within-sections = true

[tool.ruff.format]
# These are reference outputs and reformatting them makes a mess
exclude = ["tests/test_codecell_file/*ipynb"]

[tool.pytest.ini_options]
filterwarnings = [
    'error',
    'ignore:unclosed database in:ResourceWarning',
    # from asyncio triggered by jupyter_client
    'ignore:There is no current event loop:DeprecationWarning',
    'ignore:Parsing dates involving a day of month without a year specified is :DeprecationWarning',
    # from jupyter_core
    'ignore:Jupyter is migrating its paths to use standard platformdirs:DeprecationWarning',
    # nbclient
    'ignore:Parsing dates involving a day of month without a year specified is :DeprecationWarning:nbclient',
    # From dateutil in sqlalchemy and jupyter_cache
    'ignore:datetime.datetime.utcnow\(\) is deprecated:DeprecationWarning:sqlalchemy',
    'ignore:datetime.datetime.utcnow\(\) is deprecated:DeprecationWarning:jupyter_cache',
    # From matplotlib’s dependencies
    'ignore::DeprecationWarning:pyparsing',  # imports deprecated `sre_constants`
    # From myst-parser on Sphinx 9 we hit RemovedInSphinx11Warning
    'ignore:.*MystReferenceResolver.app.*',
    # Upstream myst-parser still hits env.app deprecations under Sphinx 9
    'ignore:.*env\\.app.*:DeprecationWarning:myst_parser',
    # Windows issues, some may need to be fixed in MyST-NB, others are upstream
    'ignore:Proactor event loop does not implement add_reader:RuntimeWarning:zmq',
    # We deal with this pending deprecation later
    'ignore:Argument "writer_name" will be removed in Docutils 2.0:PendingDeprecationWarning'
]

markers = [
    "sphinx_params",
]