pyds8k/pyproject.toml at develop · IBM/pyds8k · 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
[project]
name = "pyds8k"
description = "DS8000 Python Client"
dynamic = ["version"]
readme = "README.md"
license-files = ["LICENSE"]
requires-python = ">=3.9"
authors = [{ name = "Zhang Wu", email = "shwzhang@cn.ibm.com" }]
maintainers = [
    { name = "Randy Blea", email = "blead@us.ibm.com" },
    { name = "NjM3MjY5NzAgNzA3MzA3", email = "102704081+NjM3MjY5NzAgNzA3MzA3@users.noreply.github.com" },
]
keywords = ["IBM", "DS8000 Storage"]
classifiers = [
    'Development Status :: 5 - Production/Stable',
    'Intended Audience :: Developers',
    'Intended Audience :: System Administrators',
    'Environment :: Console',
    'Programming Language :: Python',
    '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',
    'Topic :: Software Development :: Libraries :: Python Modules',
]
dependencies = ["requests>=2.32.4"]
[dependency-groups]
dev = ["sphinx>=2.2.1", "ruff>=0.11.6"]
test = [
    "pytest>=7.0.0",
    "pytest-cov>=3.0.0",
    "responses>=0.24.0",
    "tox>=4.22.0",
    "tzdata>=2025.2",
    "tzlocal>=5.3.1",
]

[build-system]
requires = ["setuptools >= 77.0.0"]
build-backend = "setuptools.build_meta"

[project.urls]
Documentation = "https://pyds8k.readthedocs.io/en/latest"
Homepage = "https://github.com/IBM/pyds8k"
Issues = "https://github.com/IBM/pyds8k/issues"
Repository = "https://github.com/IBM/pyds8k.git"

[tool.setuptools.dynamic]
version = { attr = "pyds8k.version" } # Set in pyds8k/__init__.py

[tool.setuptools.packages.find]
exclude = ["cover", "images"]

[tool.ruff]
# Same as Black.
line-length = 88
indent-width = 4

# Assume Python 3.9
target-version = "py39"

[tool.ruff.lint]
extend-select = [
    "A",
    "B",
    "BLE",
    "C4",
    "C90",
    "DTZ",
    "EM",
    "EXE",
    "F",
    "FLY",
    "FURB",
    "I",
    "ICN",
    "INP",
    "INT",
    "ISC",
    "LOG",
    "N",
    "PERF",
    "PGH",
    "PIE",
    "PL",
    "PT",
    "PTH",
    "PYI",
    "RET",
    "RSE",
    "RUF",
    "SIM",
    "SLOT",
    "T2",
    "T10",
    "TID",
    "TRY",
    "UP",
    "W",
]

ignore = [
    "PLR0913", # Too many arguments in function definition
    "RUF012",  # FIXME: Mutable class attributes should be annotated with `typing.ClassVar`
]

# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

# Allow unused variables when underscore-prefixed.
dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"

[tool.ruff.lint.per-file-ignores]
"pyds8k/example.py" = [
    "T201", # allow print
]
"pyds8k/exceptions.py" = [
    "N818", # Allow custom exceptions that omit the Error suffix
]
"pyds8k/utils.py" = [
    "PLW0603", # FIXME: Using the global statement to update logger is discouraged
]
"pyds8k/client/exceptions.py" = [
    "N818", # Allow custom exceptions that omit the Error suffix
]
"pyds8k/httpclient.py" = ["PLR0912", "PLR0915"]
"pyds8k/test/test_client/test_ds8k/test_sc_client.py" = ["TRY002"]
"pyds8k/test/test_resources/test_ds8k/base.py" = ["TRY002"]
"pyds8k/test/test_resources/test_ds8k/test_resource_group.py" = ["PLR0915"]


[tool.ruff.format]
# Project has mixed strings
quote-style = "preserve"

# Like Black, indent with spaces, rather than tabs.
indent-style = "space"

# Like Black, respect magic trailing commas.
skip-magic-trailing-comma = false

# Like Black, automatically detect the appropriate line ending.
line-ending = "auto"

# Enable auto-formatting of code examples in docstrings. Markdown,
# reStructuredText code/literal blocks and doctests are all supported.
#
# This is currently disabled by default, but it is planned for this
# to be opt-out in the future.
docstring-code-format = false

# Set the line length limit used when formatting code snippets in
# docstrings.
#
# This only has an effect when the `docstring-code-format` setting is
# enabled.
docstring-code-line-length = "dynamic"