Qcodes_contrib_drivers/pyproject.toml at main · abioxinst/Qcodes_contrib_drivers · 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
[build-system]
requires = [
    "setuptools >= 77.0.3",
    "versioningit >= 2.2.1"
]
build-backend = 'setuptools.build_meta'

[project]
name = "qcodes_contrib_drivers"
description = "User contributed drivers for QCoDeS"
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Science/Research",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering",]
license = "MIT AND GPL-2.0-or-later"
license-files = [
    "LICENSE_TEKTRONIX_AWG520_KEITHLEY_2700",
    "LICENSE",
]
requires-python = ">=3.11"
dependencies = [
    "qcodes>=0.42.0",
    "versioningit>=2.2.1",
    "packaging>=20.0",
    "pandas>=1.4.0",
    "cffi>=1.17.1",
    "python-dotenv>=1.0.1",
    "autobahn>=24.4.2",
]
dynamic = [ "version",]

[[project.maintainers]]
name = "QCoDeS Community"
email = "qcodes-support@microsoft.com"

[project.readme]
file = "README.rst"
content-type = "text/x-rst"

[project.urls]
Homepage = "https://github.com/QCoDeS/Qcodes_contrib_drivers"
Documentation = "https://qcodes.github.io/Qcodes_contrib_drivers/"
Source = "https://github.com/qcodes/qcodes_contrib_drivers"
Tracker = "https://github.com/QCoDeS/Qcodes_contrib_drivers/issues"

[project.optional-dependencies]
test = [
    "pytest>=6.2.2",
    "pytest-mock>=3.0.0",
    "mypy>=0.940",
    "pytest-cov>=3.0.0",
    "coverage[toml]>=6.2",
    "PyVisa-sim>=0.6.0",
    "types-tqdm>=4.64.6",
    "pandas-stubs>=1.2.0.1",
    "pyserial",
    "windfreak>=0.3.0"
]
docs = [
    "sphinx>=8.1.3,<8.3.0",
    "furo>=2024.8.6",
    "nbsphinx>=0.8.9",
]

[tool.mypy]
strict_optional = true
disallow_untyped_decorators = true
ignore_missing_imports = false
show_column_numbers = true
warn_unused_ignores = true
warn_unused_configs = true
warn_redundant_casts = true
show_error_codes = true

[[tool.mypy.overrides]]
module = [
    "qcodes_contrib_drivers.drivers.Spectrum.pyspcm",
    "qcodes_contrib_drivers.drivers.OxfordInstruments._decsvisa.*",
    ]
ignore_errors = true

# these are packages that we import
# but either don't have stubs or we
# dont have them installed.
[[tool.mypy.overrides]]
module = [
    "cffi",
    "keysightSD1",
    "nidaqmx.*",
    "niswitch.*",
    "pandas",
    "py_header.*",
    "pyspcm",
    "spirack",
    "zhinst.*",
    "ruamel.*",
    "msl.loadlib",
    "TimeTagger",
    "AMC",
    "ACS",
    "autobahn",
    "python-dotenv",
    "serial.*",
    "scipy.*",
    "nanonis_tramea",
    "windfreak"
]
ignore_missing_imports = true

[tool.ruff.lint]
select = ["TID251"]


[tool.ruff.lint.flake8-tidy-imports.banned-api]
"qcodes.utils.deprecate".msg = "Use typing_extensions.deprecated instead. QCoDeSDeprecationWarning should be imported from qcodes.utils"
"qcodes.instrument.parameter".msg = "QCoDeS parameters should be imported from qcodes.parameters"
"qcodes.instrument.group_parameter".msg = "QCoDeS parameters should be imported from qcodes.parameters"
"qcodes.instrument.specialized_parameters".msg = "QCoDeS parameters should be imported from qcodes.parameters"
"qcodes.instrument.sweep_values".msg = "QCoDeS parameters should be imported from qcodes.parameters"
"qcodes.utils.validators".msg = "QCoDeS validators should be imported from qcodes.validators"
"qcodes.utils.threading".msg = "QCoDeS.utils.threading should be avoided. Please consult qcodes api docs for new locations"
"qcodes.utils.plotting".msg = "QCoDeS plotting utils should be imported from qcodes.plotting"
"qcodes.utils.metadata".msg = "QCoDeS.utils.metadata should be avoided. Please consult qcodes api docs for new locations"
"qcodes.utils.helpers".msg = "QCoDeS.utils.helpers should be avoided. Please consult qcodes api docs for new locations"
"qcodes.utils.dataset.doNd".msg = "QCoDeS.utils.dataset.doNd should be avoided. Please consult qcodes api docs for new locations"

[tool.setuptools]
zip-safe = false


[tool.setuptools.cmdclass]
sdist = "versioningit.cmdclass.sdist"
build_py = "versioningit.cmdclass.build_py"

[tool.versioningit]
default-version = "0.0"

[tool.versioningit.format]
distance = "{next_version}.dev{distance}+{branch}.{vcs}{rev}"
dirty = "{next_version}.dev{distance}+{branch}.{vcs}{rev}.dirty"
distance-dirty = "{next_version}.dev{distance}+{branch}.{vcs}{rev}.dirty"

[tool.versioningit.vcs]
method = "git"
match = ["v*"]

[tool.versioningit.onbuild]
source-file = "src/qcodes_contrib_drivers/_version.py"
build-file = "qcodes_contrib_drivers/_version.py"