spdk/python/pyproject.toml at master · RuiqingFeng/spdk · 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
# SPDX-License-Identifier: BSD-3-Clause
# Copyright (C) 2025 Dell Inc, or its subsidiaries.  All rights reserved.

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "spdk"
dynamic = ["version"]
readme = "README.md"
description = "Python bindings for the Storage Performance Development Kit (SPDK)"
requires-python = ">=3.9"
license = { text = "BSD-3-Clause" }

authors = [
    { name = "SPDK Authors", email = "spdk@lists.linux.dev" }
]

keywords = ["spdk", "storage", "nvme", "performance", "bindings"]

classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: BSD License",
    "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",
    "Topic :: System :: Hardware",
    "Topic :: Software Development :: Libraries :: Python Modules"
]

dependencies = []

[project.urls]
"Homepage" = "https://spdk.io"
"Source" = "https://github.com/spdk/spdk"
"Bug Tracker" = "https://github.com/spdk/spdk/issues"

[project.scripts]
spdk-rpc = "spdk.spdk_rpc:main"
spdk-sma = "spdk.spdk_sma:main"
spdk-cli = "spdk.spdk_cli:main"
spdk-mcp = "spdk.mcp:server"

[project.optional-dependencies]
sma = [
    "grpcio",
    "protobuf",
    "pyyaml"
]
cli = [
    "configshell_fb"
]
mcp = [
    "mcp[cli]>=1.9.2"
]
dev = [
    "grpcio",
    "grpcio-tools",
    "ijson",
    "jinja2",
    "meson",
    "ninja",
    "pandas",
    "pyelftools",
    "python-magic",
    "pyyaml",
    "tabulate",
    "ruff",
    "mypy",
    "build",
    "twine",
    "uv",
    "scikit-build; platform_machine == 'aarch64'"
]

[tool.hatch.version]
path = "spdk/version.py"

[tool.hatch.build.targets.sdist]
core-metadata-version = "2.4"

# TODO: this is not ideal, better move pyproject file to the top
[tool.hatch.build.targets.sdist.force-include]
"../scripts/rpc.py" = "../scripts/rpc.py"
"../scripts/sma.py" = "../scripts/sma.py"
"../scripts/spdkcli.py" = "../scripts/spdkcli.py"

[tool.hatch.build.targets.wheel]
core-metadata-version = "2.4"

[tool.hatch.build.targets.wheel.force-include]
"../scripts/rpc.py" = "spdk/spdk_rpc.py"
"../scripts/sma.py" = "spdk/spdk_sma.py"
"../scripts/spdkcli.py" = "spdk/spdk_cli.py"

[tool.ruff]
fix = false
line-length = 140
exclude = [
    "xnvme",
    "python/spdk/sma",
    "ocf",
    "libvfio-user",
    "intel-ipsec-mb",
    "dpdk",
]

[tool.ruff.lint]
select = [
    "E",  # pycodestyle errors
    "F",  # pyflakes
    "W",  # warnings
    "I",  # isort (import sorting)
    "B",  # flake8-bugbear
    "A",  # flake8-builtins
    "COM",# flake8-commas
    "RUF",# Ruff-specific rules
]
ignore = [
    "RUF012",        # mutable class attributes must use ClassVar
]

[tool.mypy]
exclude = [
    "/spdk/sma",
    "/spdk/spdkcli",
]