pyproject.toml

[build-system]
requires = ["setuptools>=61.2", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "sepal-ui"
version = "2.20.0"
description = "Wrapper for ipyvuetify widgets to unify the display of voila dashboards in SEPAL platform"
keywords = ["UI", "Python", "widget", "sepal"]
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "Topic :: Software Development :: Build Tools",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
]
requires-python = ">=3.8"
dependencies = [
    # building widgets
    "tomli",
    "ipykernel",
    "ipyvuetify",
    "markdown",
    "ipyleaflet>=0.14.0",  # to have access to data member in edition
    # earthengine management
    "earthengine-api",
    # to create a module
    "colorama",
    "pipreqs",
    # read local data
    "rioxarray",
    "dask",  # used by rioxarray in the inspector
    'geopandas==0.13.2; python_version == "3.8"',
    'geopandas>=0.14.0; python_version > "3.8"',
    "matplotlib",
    "jupyter-server-proxy", # required for localtileserver
    "planet",
    "pyarrow",
    "localtileserver>=0.7.0", # first pure rio version
    "pygaul>=0.3.1", # use the class implementation
    "pygadm>=0.5.0", # use the class implementation
    # miscellaneous
    "python-box",
    "tqdm",
    "Deprecated>=1.2.14",
    "anyascii",  # to decode international names with non latin characters
    "natsort",
    "typing-extensions",
    "nest-asyncio", # planet API interaction
]

[[project.authors]]
name = "Pierrick Rambaud"
email = "pierrick.rambaud49@gmail.com"

[project.license]
text = "MIT"

[project.readme]
file = "README.rst"
content-type = "text/x-rst"

[project.urls]
Homepage = "https://github.com/12rambau/sepal_ui"
Download = "https://github.com/12rambau/sepal_ui/archive/v_${metadata:version}.tar.gz"

[project.optional-dependencies]
dev = [
    "pre-commit>=2.18.0",
    "commitizen",
    "nox",
    "tomli",
    "jupyter",
    "voila",
    "mypy",
]
test = [
    "pytest",
    "pytest-sugar",
    "pytest-icdiff",
    "pytest-cov",
    "pytest-deadfixtures",
    "Flake8-pyproject",
    "nbmake",
    "pytest-regressions",
    "tomli",
]
doc = [
    "sphinx @ git+https://github.com/sphinx-doc/sphinx.git",
    "jupyter-sphinx",
    "pydata-sphinx-theme",
    "sphinx-notfound-page",
    "sphinx-copybutton",
    "m2r2>=0.3.3",
    "sphinxcontrib-autoprogram",
    "sphinx-favicon>=1.0.1",
    "tomli",
    "lxml_html_clean",
]

[project.scripts]
module_deploy = "sepal_ui.bin.module_deploy:main"
module_factory = "sepal_ui.bin.module_factory:main"
module_l10n = "sepal_ui.bin.module_l10n:main"
module_theme = "sepal_ui.bin.module_theme:main"
module_venv = "sepal_ui.bin.module_venv:main"
activate_venv = "sepal_ui.bin.activate_venv:main"
sepal_ipyvuetify = "sepal_ui.bin.sepal_ipyvuetify:main"
entry_point = "sepal_ui.bin.entry_point:main"

[tool.setuptools]
include-package-data = false
license-files = ["LICENSE.txt"]

[tool.setuptools.packages.find]
include = ["sepal_ui*"]
exclude = ["docs*", "tests*"]

[tool.setuptools.package-data]
sepal_ui = [
    "data/*",
    "message/**/*",
    "frontend/**/*",
    "templates/**/*",
]

[tool.commitizen]
changelog_file = "CHANGELOG.md"
changelog_incremental = true
tag_format = "v$major.$minor.$patch$prerelease"
update_changelog_on_bump = false
version = "2.20.0"
version_files = [
    "pyproject.toml:version",
    "sepal_ui/__init__.py:__version__"
]

[tool.pytest.ini_options]
testpaths = "tests"

[tool.ruff]
ignore-init-module-imports = true
fix = true
select = ["E", "F", "W", "I", "D", "RUF"]
ignore = [
    "E501",  # line too long | Black take care of it
    "W605",  # invalid escape sequence | we escape specific characters for sphinx
    "D200", # One-line docstring should fit on one line | too late
    "D101", # Missing docstring in public class | set it in __init__
    "D417", #  Missing argument descriptions in the docstring | seems buggy TODO

]

# init file are here to hide the internal structure to the user of the lib
exclude = ["*/__init__.py", "docs/source/conf.py"]

[tool.ruff.flake8-quotes]
docstring-quotes = "double"

[tool.ruff.pydocstyle]
convention = "google"

[tool.ruff.per-file-ignores]
"*/__init__.py" = ["F403"] # unable to detect undefined names | hide internal structure
"setup.py" = ["D100"] # nothing to see there

[tool.coverage.run]
source = ["sepal_ui"]
omit = [
    "sepal_ui/*/__init__.py",
    "sepal_ui/scripts/messages.py",
    "sepal_ui/reclassify/parameters.py",
]

[tool.doc8]
ignore = ["D001"] # we follow a 1 line = 1 paragraph style
ignore-path-errors = ["docs/source/index.rst;D000"]

[tool.licensecheck]
using = "PEP631:test;dev;doc"

[tool.codespell]
skip = 'CHANGELOG.md,sepal_ui/message/**/*.json,sepal_ui/data/gaul_iso.json'

[tool.black]
line-length = 100