template/pyproject.toml at master · qctrl/template · 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
# How to use this file
# - Copy this file to the root of your repository
# - Update the values as per the instructions in the comments
# - Remove all comments
#
# More information
# - https://packaging.python.org/en/latest/specifications/pyproject-toml/
# - https://code.q-ctrl.com/packaging#python
# - https://python-poetry.org/docs/pyproject/

[project]

# TODO: Update with the "Install" name as defined in https://code.q-ctrl.com/naming-conventions/#packages
name = "qctrl-template"

# TODO: Update with the "Package" name as defined in https://code.q-ctrl.com/naming-conventions/#packages
description = "Q-CTRL Template"

# TODO: Update with the supported Python versions
requires-python = ">=3.13, <3.14"

# TODO: Update with the "Version" as defined in https://code.q-ctrl.com/releases#version
# - Remove if the repository does not maintain a version
version = "0.1.0"

# TODO: Update with the license as defined in https://code.q-ctrl.com/licensing
# - Commercial = "https://q-ctrl.com/terms"
# - Open source = "Apache-2.0"
# - Unlicensed = ""
license = "Apache-2.0"

# DO NOT EDIT - the README.md file as defined in https://github.com/qctrl/template/blob/master/README.md
# - Remove if not required
readme = "README.md"

# DO NOT EDIT
authors = [
  {name = "Q-CTRL", email = "support@q-ctrl.com>"}
]

# DO NOT EDIT
maintainers = [
  {name = "Q-CTRL", email = "support@q-ctrl.com>"}
]

# DO NOT EDIT
keywords = [
  "black opal",
  "boulder opal",
  "fire opal",
  "ironstone opal",
  "nisq",
  "open controls",
  "q control",
  "q ctrl",
  "q-control",
  "q-ctrl",
  "qcontrol",
  "qctrl",
  "quantum",
  "quantum algorithms",
  "quantum circuits",
  "quantum coding",
  "quantum coding software",
  "quantum computing",
  "quantum control",
  "quantum control software",
  "quantum control theory",
  "quantum engineering",
  "quantum error correction",
  "quantum firmware",
  "quantum fundamentals",
  "quantum navigation",
  "quantum sensing",
  "qubit",
  "qudit",
]

# TODO: Remove `classifiers` if the repository does not implement a publicly available package
dynamic = ["classifiers", "dependencies"]

# TODO: Replace `[repository]` in the `Source` with the repository name
# TODO: Update `Documentation` with a link to the "User documentation" as defined in https://code.q-ctrl.com/documentation#user-documentation
# - Remove otherwise.
[project.urls]
Source = "https://github.com/qctrl/[repository]"
Homepage = "https://q-ctrl.com"
Documentation = "https://docs.q-ctrl.com"
LinkedIn = "https://www.linkedin.com/company/q-ctrl/"
Facebook = "https://www.facebook.com/qctrl"
X = "https://x.com/qctrlHQ"
YouTube = "https://www.youtube.com/qctrl"
GitHub = "https://github.com/qctrl"

# DO NOT EDIT
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

[tool.poetry]

# TODO: Remove if the repository implements a package
package-mode = false

# TODO: Remove if the repository does not implement a publicly available package
# - Update supported Python versions otherwise.
classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Environment :: Console",
    "Intended Audience :: Developers",
    "Intended Audience :: Education",
    "Intended Audience :: Science/Research",
    "Natural Language :: English",
    "Operating System :: OS Independent",
    "Topic :: Internet :: WWW/HTTP",
    "Topic :: Scientific/Engineering :: Physics",
    "Topic :: Scientific/Engineering :: Visualization",
    "Topic :: Software Development :: Embedded Systems",
    "Topic :: System :: Distributed Computing"
]

# TODO: Update with the "Import" name as defined in https://code.q-ctrl.com/naming-conventions
# - Remove if the repository doesn't implement a package
packages = [
    { include = "qctrltemplate" },
]

# Uncomment the following 2 blocks if the package requires access to the internal PyPI.
# # Use the public PyPI as the main source: DO NOT EDIT
# [[tool.poetry.source]]
# name = "PyPI"
# priority = "primary"

# # Use the internal PyPI as the supplemental source: DO NOT EDIT
# [[tool.poetry.source]]
# name = 'Artifactory'
# url = 'https://qctrl.jfrog.io/artifactory/api/pypi/qctrl/simple/'
# priority = "supplemental"