pyinaturalist/pyproject.toml at main · pyinat/pyinaturalist · 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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
[project]
name = 'pyinaturalist'
version = '1.0.0'
description = 'iNaturalist API client for python'
authors = [{ name = 'Jordan Cook' }]
license = 'MIT'
readme = 'README.md'
keywords = [
    'inaturalist',
    'biodiversity',
    'conservation',
    'citizen-science',
    'community-science',
    'api',
    'api-client',
    'data-model',
    'requests',
]
classifiers = [
    'Development Status :: 4 - Beta',
    'Intended Audience :: Developers',
    'Intended Audience :: Education',
    'Intended Audience :: Science/Research',
    'Programming Language :: Python :: 3',
    'Programming Language :: Python :: 3.8',
    'Programming Language :: Python :: 3.9',
    'Programming Language :: Python :: 3.10',
    'Programming Language :: Python :: 3.11',
    'Programming Language :: Python :: 3.12',
    'Programming Language :: Python :: 3.13',
    'Programming Language :: Python :: 3.14',
    'Programming Language :: Python :: 3.15',
    'Topic :: Software Development :: Libraries :: Python Modules',
    'Typing :: Typed',
]
requires-python = '>=3.10'
dependencies = [
    'attrs>=21.2',
    'keyring>=22.3',
    'platformdirs>=2.6',
    'python-dateutil>=2.0',
    'requests>=2.26',
    'requests-cache>=1.3',
    'requests-ratelimiter>=0.9',
    'rich>=10.9',
]

[project.urls]
homepage = 'https://github.com/pyinat/pyinaturalist'
repository = 'https://github.com/pyinat/pyinaturalist'
documentation = 'https://pyinaturalist.readthedocs.io'

[project.optional-dependencies]
# Optional dependencies
all = [
    'filelock>2.0',
    'ujson>5.0',
]

[dependency-groups]
# Dev dependencies
dev = [
    'dotenv>=0.9',
    'nox~=2026.2',
    'prek>=0.2',
    'pretty-errors>=1.2',
    'pytest>=8.0',
    'pytest-asyncio>=0.21',
    'pytest-cov>=5.0',
    'pytest-xdist>=2.2',
    'requests-mock~=1.12',
    'sphinx-autobuild>=2021.3',
    'starlette<0.28',  # For compatibility with sphinx-autobuild
]

# Documentation dependencies for Readthedocs builds
docs = [
    'furo~=2025.12; python_version>="3.12"',
    'ipython~=8.12; python_version>="3.12"',
    'linkify-it-py~=2.1; python_version>="3.12"',
    'matplotlib>=3.7; python_version>="3.12"',
    'myst-parser>=5.0; python_version>="3.12"',
    'myst-nb>=1.2; python_version>="3.12"',
    'pillow>=10.1; python_version>="3.12"',
    'sphinx~=9.1; python_version>="3.12"',
    'sphinx-automodapi~=0.22; python_version>="3.12"',
    'sphinx-autodoc-typehints==3.8; python_version>="3.12"',
    'sphinx-copybutton>=0.5; python_version>="3.12"',
    'sphinx-design>=0.7; python_version>="3.12"',
    'sphinxcontrib-apidoc~=0.6; python_version>="3.12"',
    'sphinxext-opengraph>=0.9; python_version>="3.12"',
]

[build-system]
requires = ['hatchling>=1.0.0']
build-backend = 'hatchling.build'

[tool.hatch.build]
packages =  ['pyinaturalist', 'pyinat']
force-include = {'README.md' = 'pyinaturalist/README.md'}

[tool.coverage.html]
directory = 'test-reports'

[tool.coverage.run]
branch = true
source = ['pyinaturalist', 'pyinat']
omit = [
    'pyinaturalist/docs/model_docs.py',
    'pyinaturalist/docs/forge.py',
]

[tool.coverage.report]
exclude_lines = [
    'pragma: no cover',
    'if TYPE_CHECKING:',
]

[tool.mypy]
ignore_missing_imports = true
pretty = true
show_column_numbers = true
show_error_codes = true
warn_redundant_casts = true
warn_unused_ignores = true
files = ['pyinaturalist']

[tool.pytest.ini_options]
markers = [
    'enable_client_session: Enable all ClientSession features: caching, rate-limiting, etc.',
]
asyncio_default_fixture_loop_scope = 'module'

[tool.ruff]
fix = true
unsafe-fixes = true
line-length = 100
output-format = 'grouped'
exclude = ['examples/', 'scripts/specs/', 'test/sample_data/']

[tool.ruff.format]
quote-style = 'single'

[tool.ruff.lint]
select = ['B', 'C4', 'E', 'F', 'I']

[tool.ruff.lint.isort]
known-first-party = ['test']

# Wrap lines to 100 chars, but don't error on unwrappable lines until 120 chars
[tool.ruff.lint.pycodestyle]
max-line-length = 120

[tool.typos]
files.extend-exclude = [
    'CONTRIBUTORS.md',
    'examples/',
    'scripts/specs/',
    'test/sample_data/',
]

[tool.typos.default.extend-words]
Oficial = 'Oficial'
ND = 'ND'