pyproject.toml

[build-system]
requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "conflowgen"
dynamic = [
    "version",
    "license",
    "description",
    "readme",
]
authors = [
  {name = "Marvin Kastner", email = "marvin.kastner@tuhh.de"},
]
requires-python = ">=3.9"
dependencies = [
    # working with distributions and statistics
    "scipy >=1.10.0-rc1",  # used for, e.g., the lognorm distribution, version fixed due to CVE-2023-25399

    # data export
    'numpy',  # used in combination with pandas for column types
    'pandas >=1',  # CSV/Excel export
    'openpyxl',  # optional dependency of pandas that is compulsory for xlsx export
    'PyYAML',  # export of metadata

    # internal data keeping
    'peewee >=3',  # ORM mapper

    # documentation - decorators used for sphinx but are part of the source code delivered to customers
    'enum_tools >=0.7',  # used for documenting enums via decorators - previous versions are not compatible

    # for creating the visuals
    'matplotlib',  # default plots such as bar charts, pie charts, etc.
    'plotly',  # useful for, e.g., Sankey diagrams
    'kaleido>=1.0',  # plotly depends on this package for exporting its figures, we got this as a present
]

[project.optional-dependencies]
# Only needed to run the unittests and generate the documentation
dev = [
    # testing
    'pytest',  # running the unit tests
    'pytest-cov',  # create coverage report
    'pytest-xdist',  # use several processes to speed up the testing process
    'pytest-github-actions-annotate-failures',  # turns pytest failures into action annotations
    'parameterized',  # for parameterized testing
    'seaborn',  # some visuals in unittests are generated by seaborn
    'nbconvert',  # used to run tests in Jupyter notebooks, see ./test/notebooks/test_run_notebooks.py
    'nbformat',  # used to run tests in Jupyter notebooks

    # build documentation
    'sphinx >=6.2',  # build the documentation - restrict version to improve pip version resolution
    'sphinx-rtd-theme',  # adding the nice sphinx theme
    'sphinx-toolbox >=3',  # additional dependency of enum_tools - restrict version to improve pip resolution
    'myst-parser',  # for Contributing.md
    'sphinxcontrib-bibtex >=2.4',  # a good help for citing - restrict version to improve pip resolution
    'sphinx-last-updated-by-git',  # add a timestamp into the documentation indicating the last changes
    'nbsphinx',  # use Jupyter Notebooks in the documentation
    'ipython',  # for setting up the pygments_lexer
    'ipykernel',  # for allowing nbsphinx to execute the Jupyter Notebooks
    'docutils',  # for typehinting inside conf.py

    # checking code quality
    'pylint',  # lint Python code
    'flake8',  # lint Python code
    'ruff',  # lint Python code, also inside Jupyter notebooks

    # publish at PyPI
    'build',  # create pypi package using `python -m build`
    'twine',  # check and upload package to PyPI

    # pip resolution issue - https://github.com/pypa/pip/issues/12430#issuecomment-1849059000
    'sphinx-tabs',
]

# a collection of nice-to-haves for working on Jupyter Notebooks - just a favorites list of the authors
jupyterlab = [
    'jupyterlab',  # continue development on the Jupyter Notebooks included in this repository
    "jupyterlab-spellchecker",  # avoid typos in documentation
    "jupyterlab-lsp",  # better autocomplete
    "python-lsp-server[all]",  # better autocomplete
]