SkyLink-API-Python-SDK/pyproject.toml at main · SkyLink-API/SkyLink-API-Python-SDK · 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
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "skylink-api"
dynamic = ["version"]
description = "Official Python SDK for the SkyLink API — aviation data: live ADS-B, weather, airports, charts, NOTAMs, flight status and more."
readme = "README.md"
license = { file = "LICENSE" }
requires-python = ">=3.10"
authors = [{ name = "SkyLink API", email = "hello@skylinkapi.com" }]
keywords = [
    "skylink",
    "aviation",
    "adsb",
    "metar",
    "taf",
    "notam",
    "flight-tracking",
    "airports",
    "aviation-weather",
    "api-client",
    "sdk",
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3 :: Only",
    "Typing :: Typed",
    "Topic :: Software Development :: Libraries :: Python Modules",
    "Topic :: Scientific/Engineering :: Atmospheric Science",
]
dependencies = ["httpx>=0.25,<1", "pydantic>=2.5,<3"]

[project.optional-dependencies]
# `skylink_api.pandas_ext.to_dataframe` — the only part of the SDK that needs it,
# and it imports pandas lazily, so this stays out of the default install.
pandas = ["pandas>=2.0"]
dev = [
    "pytest>=8.0",
    "pytest-asyncio>=0.23",
    "respx>=0.21",
    "ruff>=0.6",
    "mypy>=1.11",
    "build>=1.2",
    "twine>=5.0",
    "pandas>=2.0", # so CI runs tests/test_pandas_ext.py instead of skipping it
]

[project.urls]
Homepage = "https://skylinkapi.com"
Documentation = "https://skylinkapi.com/docs"
Repository = "https://github.com/SkyLink-API/SkyLink-API-Python-SDK"
Changelog = "https://github.com/SkyLink-API/SkyLink-API-Python-SDK/blob/main/CHANGELOG.md"
Issues = "https://github.com/SkyLink-API/SkyLink-API-Python-SDK/issues"

[tool.hatch.version]
path = "src/skylink_api/_version.py"

[tool.hatch.build.targets.wheel]
packages = ["src/skylink_api"]

[tool.hatch.build.targets.sdist]
include = ["/src", "/tests", "/examples", "/README.md", "/CHANGELOG.md", "/LICENSE"]

[tool.ruff]
line-length = 100
target-version = "py310"
src = ["src", "tests"]

[tool.ruff.lint]
select = ["E", "F", "I", "UP", "B", "SIM", "RUF"]
ignore = [
    "B008",   # function call in default argument — not applicable, but noisy with sentinels
    "RUF001", # ambiguous unicode in docstrings (aviation symbols)
]

[tool.ruff.lint.per-file-ignores]
"tests/*" = ["E501"]

[tool.mypy]
python_version = "3.10"
strict = true
warn_unreachable = true
files = ["src/skylink_api"]

[[tool.mypy.overrides]]
module = "tests.*"
strict = false

# pandas ships no py.typed marker; it is an optional extra used behind
# `if TYPE_CHECKING` in `pandas_ext`, so type-checking must not depend on it.
[[tool.mypy.overrides]]
module = "pandas.*"
ignore_missing_imports = true

[tool.pytest.ini_options]
testpaths = ["tests"]
asyncio_mode = "auto"
addopts = "-q --strict-markers"
markers = [
    "integration: hits a live SkyLink API instance; requires SKYLINK_TEST_BASE_URL",
]