mappymatch/pyproject.toml at main · NatLabRockies/mappymatch · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "mappymatch"
dynamic = ["version"]
description = "Pure python package for map-matching."
readme = "README.md"
authors = [{ name = "National Laboratory of the Rockies" }]
license = { text = "BSD 3-Clause License Copyright (c) 2022, Alliance for Energy Innovation, LLC" }
classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Science/Research",
  "License :: Other/Proprietary License",
  "Operating System :: OS Independent",
  "Programming Language :: Python",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Topic :: Scientific/Engineering",
]
keywords = ["GPS", "map", "match"]
dependencies = [
  "geopandas>=1,<2",
  "osmnx>=2,<3",
  "shapely>=2,<3",
  "pyproj>=3,<4",
  "pandas>=2,<3",
  "numpy>=2,<3",
  "matplotlib>=3,<4",
  "networkx>=3,<4",
  "igraph>=1.0,<2",
  "folium>=0.20,<1",
  "requests>=2,<3",
  "polyline>=2,<3",
]
requires-python = ">=3.10"

[project.optional-dependencies]
# Used to run CI.
tests = ["ruff>=0.14,<1", "mypy>=1,<2", "types-requests", "pytest>=9,<10"]
# Used to build the docs.
docs = [
  "jupyter-book>=1.0,<2.0",
  "sphinx-book-theme",
  "sphinx-autodoc-typehints",
  "sphinxcontrib-autoyaml",
  "sphinxcontrib.mermaid",
]
# Tests + docs + other.
dev = [
  "hatch>=1,<2",
  "mappymatch[tests]",
  "mappymatch[docs]",
  "coverage",
  "pre-commit",
]

[project.urls]
Homepage = "https://github.com/NatLabRockies/mappymatch"

[tool.hatch.version]
path = "mappymatch/__about__.py"

[tool.hatch.build.targets.sdist]
exclude = ["tests/", "docs/", "examples/"]

[tool.ruff]
exclude = ["build/*", "dist/*"]

# Same as Black.
line-length = 88
indent-width = 4

# Assume Python 3.9
target-version = "py39"

[tool.ruff.lint]
# Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`)  codes by default.
# Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
# McCabe complexity (`C901`) by default.
select = ["E4", "E7", "E9", "F"]
ignore = []

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

[tool.mypy]
ignore_missing_imports = true
exclude = ["docs/", "build/", "dist/", "py-notebooks/"]

[tool.coverage.run]
# Ensures coverage for all if, elif, else branches.
# https://coverage.readthedocs.io/en/6.3.2/branch.html#branch
branch = true

[tool.coverage.report]
precision = 1
fail_under = 50.0
skip_covered = false
skip_empty = true

[tool.pixi.workspace]
channels = ["conda-forge"]
platforms = ["osx-arm64"]

[tool.pixi.pypi-dependencies]
mappymatch = { path = ".", editable = true }

[tool.pixi.environments]
default = { solve-group = "default" }
dev = { features = ["dev", "tests", "docs"], solve-group = "default" }
docs = { features = ["docs"], solve-group = "default" }
tests = { features = ["tests"], solve-group = "default" }

[tool.pixi.feature.dev.tasks]
fmt_fix = "ruff format"
lint_fix = "ruff check --fix"
typing = "mypy ."
test = "pytest tests/"
examples = "python docs/examples/lcss_example.py"
convert_notebooks = "python docs/examples/_convert_examples_to_notebooks.py"
docs = { depends-on = [
  "convert_notebooks",
], cmd = "cd docs/ && jupyter-book build ." }
check = { depends-on = ["fmt_fix", "lint_fix", "typing", "test", "examples"] }