jitx-protocols-ext/pyproject.toml at main · JITx-Inc/jitx-protocols-ext · 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
[build-system]
requires = ["hatchling>=1.27.0,<2.0"]
build-backend = "hatchling.build"

[project]
name = "jitx-protocols-ext"
version = "0.1.0"
description = "JITX protocol bundles, signal integrity constraints, and example designs for high-speed interfaces"
readme = "README.md"
requires-python = ">=3.12"
license = "MIT"
dependencies = [
  "jitx>=4.0.0,<5",
  "jitxlib-parts>=1.0.0,<2",
  "jitxlib-standard>=4.0.0,<5",
]
classifiers = [
  "Development Status :: 3 - Alpha",
  "Intended Audience :: Developers",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
]

[project.urls]
Homepage = "https://github.com/JITx-Inc/jitx-protocols-ext"
Repository = "https://github.com/JITx-Inc/jitx-protocols-ext"
Issues = "https://github.com/JITx-Inc/jitx-protocols-ext/issues"

[project.optional-dependencies]
examples = [
  "jitxexamples-components>=1.0.0,<2",
]
dev = [
  "pytest>=8.0",
  "pytest-cov>=5.0",
  "ruff>=0.4",
  "pyright>=1.1",
]

# ---------------------------------------------------------------------------
# Hatch build
# ---------------------------------------------------------------------------

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

[tool.hatch.build.targets.sdist]
exclude = [
  "designs/",
  "parts-db/",
  "3d-models/",
  ".venv/",
  ".vscode/",
]

# ---------------------------------------------------------------------------
# Hatch environments
# ---------------------------------------------------------------------------

[tool.hatch.envs.default]
features = ["dev"]

[tool.hatch.envs.test]
features = ["dev"]

[tool.hatch.envs.test.scripts]
run = "pytest {args:tests}"
cov = "pytest --cov=jitx_protocols_ext --cov-report=term-missing {args:tests}"

[[tool.hatch.envs.test.matrix]]
python = ["3.12", "3.13"]

[tool.hatch.envs.lint]
detached = true
dependencies = ["ruff>=0.4"]

[tool.hatch.envs.lint.scripts]
check = "ruff check {args:.}"
fmt = "ruff format {args:.}"

[tool.hatch.envs.types]
features = ["dev"]

[tool.hatch.envs.types.scripts]
check = "pyright {args:src/jitx_protocols_ext}"
stats = "pyright --stats {args:src/jitx_protocols_ext}"

# ---------------------------------------------------------------------------
# Tool configuration
# ---------------------------------------------------------------------------

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

[tool.ruff]
target-version = "py312"
line-length = 100

[tool.ruff.lint]
select = [
  "E",    # pycodestyle errors
  "F",    # pyflakes
  "I",    # isort
  "UP",   # pyupgrade
  "B",    # flake8-bugbear
  "SIM",  # flake8-simplify
  "RUF",  # ruff-specific rules
]
ignore = [
  "RUF009",  # function calls in dataclass defaults (Toleranced is immutable)
  "RUF012",  # mutable class-var defaults (JITX Port() lists are intentional)
]

[tool.ruff.lint.isort]
known-first-party = ["jitx_protocols_ext"]

[tool.pyright]
pythonVersion = "3.12"
typeCheckingMode = "standard"
extraPaths = ["src"]