Developer Guide#

To install for development, execute:

git clone https://github.com/snek5000/snek5000.git
cd snek5000
pip install -e ".[dev]"

Note

Specifying [dev] would also install optional dependencies, namely:

[options.extras_require]
docs =
    sphinx
    myst-parser
    myst-nb
    docutils <0.18, >=0.14  # sphinx, myst-parser and myst-nb is incompatible with docutils==0.18
    sphinx-autobuild
    sphinx-copybutton
    sphinx-inline-tabs
    furo
    breathe
    setuptools_scm
    nbdime
    # https://github.com/sphinx-doc/sphinx/issues/8198
    pygments >= 2.4.1
    linkify-it-py
    scipy
    snek5000-tgv
    snek5000-phill
    snek5000-cbox

tests =
    nox
    pytest
    coverage[toml]
    pytest-cov
    pytest-datadir
    pytest-mock
    ipython

hpc =
    %(tests)s
    click

dev =
    %(docs)s
    %(hpc)s
    rich
    pdbpp
    python-lsp-server
    fortran-language-server
    pre-commit>=2.9.0
    twine
    build

Reference

How to for developers / maintainers of Snek5000 package