submodule_template/pyproject.toml at main · pysal/submodule_template · 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
[build-system]
requires = [
    "setuptools>=61.0.0", "setuptools_scm[toml]>=6.2"
]
build-backend = "setuptools.build_meta"

[project]
name = "PACKAGE_NAME"
dynamic = ["version"]
maintainers = [
    {name = "MAINTAINER_NAME", email = "MAINTAINER_EMAIL@gmail.com"},
]
license = {text = "BSD 3-Clause"}
description = "short <80chr description"
keywords = ["some", "key", "words"]
readme = {text = """\
Longer description; can be from README.md
""", content-type = "text/x-rst"}
classifiers = [
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "License :: OSI Approved :: BSD License",
    "Operating System :: OS Independent",
    "Intended Audience :: Science/Research",
    "Topic :: Scientific/Engineering :: GIS",
]
requires-python = ">=3.8"
dependencies = [
    "numpy>=1.3",
    "pandas>=1.0",
    "scipy>=1.0",
]

[project.urls]
Home = "https://pysal.org/PACKAGE_NAME/"
Repository = "https://github.com/pysal/PACKAGE_NAME"

[project.optional-dependencies]
dev = [
    "black",
    "pre-commit",
    "ruff",
]
docs = [
    "nbsphinx",
    "numpydoc",
    "sphinx",
    "sphinxcontrib-bibtex",
    "sphinx_bootstrap_theme",
]
tests = [
    "codecov",
    "coverage",
    "pytest",
    "pytest-cov",
    "pytest-xdist",
]
plus = [  # this section can have any name desired; there can be any number of them
    "ANY_OTHER_OPTIONAL_PACKAGES"
]

[tool.setuptools.packages.find]
include = [
    "PACKAGE_NAME",
    "PACKAGE_NAME.*",
]

[tool.coverage.run]
omit = ["PACKAGE_NAME/test_*"]
source = ["PACKAGE_NAME"]

[tool.coverage.report]
ignore_errors = true
omit = ["PACKAGE_NAME/test_*"]

[tool.ruff]
line-length = 88
select = [  # ruff's rule codes -- https://beta.ruff.rs/docs/rules/
    "F",  # flake8/pyflake; required
    "I",  # isort; required
    "UP",  # upgrade checking; required
    "A",  # builtins; optional but strongly encouraged
    "ARG",  # unused arguments; optional but strongly encouraged
    "E",  # errors; optional but strongly encouraged
    "N",  # pep8 naming; optional but strongly encouraged
    "W",  # warnings; optional but strongly encouraged
    "B",  # bugbear; optional
    "C4",  # comprehensions; optional
    "SIM",  # simplify; optional
]
exclude = ["PACKAGE_NAME/test_*", "docs/*"]
target-version = "py38"
ignore = ["B006"]

[tool.black]
line-length = 88
extend-exclude = '''
(
  docs/*
)
'''