Skip to content

Commit 607b8e7

Browse files
author
Tobias Ahrens
committed
Make blank package placeholder
This commit removes all sources from the python package. The reason is that the package has been deprecated and we want a clean pypi version
1 parent 70bb3f1 commit 607b8e7

66 files changed

Lines changed: 16 additions & 17079 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/code_quality.yml

Lines changed: 0 additions & 25 deletions
This file was deleted.

.github/workflows/tests.yml

Lines changed: 0 additions & 41 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 0 additions & 78 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

README.md

Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,6 @@
1-
| | |
2-
| --- | --- |
3-
| Package | [![PyPI version](https://badge.fury.io/py/labone.svg)](https://badge.fury.io/py/labone) |
4-
| Meta | [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![linting - Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v0.json)](https://github.com/charliermarsh/ruff) [![code style - Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)|
5-
| CI | ![](https://github.com/zhinst/labone-python/actions/workflows/github-code-scanning/codeql/badge.svg) ![](https://codecov.io/gh/zhinst/labone-python/branch/main/graph/badge.svg?token=VUDDFQE20M) ![](https://github.com/zhinst/labone-python/actions/workflows/code_quality.yml/badge.svg) ![](https://github.com/zhinst/labone-python/actions/workflows/tests.yml/badge.svg) |
6-
-----
7-
81
# LabOne Python API
92

10-
The `labone` package provides a plain asynchronous Python API for [LabOne](https://www.zhinst.com/labone), the control software of Zurich Instruments.
11-
12-
> [!CAUTION]
13-
> This API package is solely being developed to support [LabOne Q](https://www.zhinst.com/quantum-computing-systems/labone-q), the software framework for quantum computing.
14-
>
15-
> For direct access to the instruments without LabOne Q, the standard Python API for all Zurich Instruments' devices is provided through the `zhinst` package and can be obtained from [PyPI](https://pypi.org/project/zhinst/) by `pip install zhinst`.
16-
>
17-
18-
> [!NOTE]
19-
> Since `labone` is not intended for direct usage, we do not offer any support
20-
> or external documentation. Please contact [Zurich Instruments](mailto:info@zhinst.com) if you have any questions.
21-
22-
## LabOne compatibility
23-
The `labone` package is broadly compatible with any LabOne version greater or equal than 23.06. When used with older versions of LabOne, some features may not be available or only partially working.
24-
25-
| `labone` version | Minimum LabOne version | Best with LabOne |
26-
| ---------------- | ---------------------- | ---------------- |
27-
| up to 2.3 | 23.06 | 23.06 or later |
28-
| up to 3.1.2 | 23.06 | 24.10 or later |
29-
| from 3.2.0 | 23.06 | 25.01 or later |
30-
31-
## Internal Documentation
32-
33-
The internal documentation can be found [here](http://docs.pages.zhinst.com/internal-documentation-hub/async_labone/index.html).
34-
Due to the early stage there is not public documentation.
35-
36-
## Contributing
3+
The `labone` package has been removed for the time being.
4+
Please refer to [zhinst-toolkit](https://pypi.org/project/zhinst-toolkit/)
5+
for the latest LabOne Python API.
376

38-
See [Contributing](CONTRIBUTING.md)

pyproject.toml

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
55
[project]
66
name = "labone"
77
dynamic = ["version"]
8-
description = "Python API for Zurich Instruments LabOne software."
8+
description = "Zurich Instruments."
99
readme = "README.md"
1010
license = { text = "Apache 2.0" }
1111
requires-python = ">=3.9"
@@ -14,7 +14,7 @@ authors = [
1414
]
1515
keywords = ["zhinst"]
1616
classifiers = [
17-
"Development Status :: 3 - Alpha",
17+
"Development Status :: 7 - Inactive",
1818
"Intended Audience :: Developers",
1919
"Intended Audience :: Science/Research",
2020
"License :: OSI Approved :: Apache Software License",
@@ -26,17 +26,11 @@ classifiers = [
2626
"Programming Language :: Python :: 3.13",
2727
"Topic :: Scientific/Engineering",
2828
]
29-
dependencies = [
30-
"numpy>=1.20",
31-
"packaging",
32-
"typing_extensions>=4.8.0",
33-
"zhinst-comms~=3.0",
34-
]
29+
dependencies = []
3530

3631
[project.urls]
3732
homepage = "https://zhinst.com"
38-
repository = "https://github.com/zhinst/labone-python"
39-
changelog = "https://github.com/zhinst/labone-python/blob/main/CHANGELOG.md"
33+
repository = "https://github.com/zhinst/toolkit"
4034

4135

4236
[tool.hatch.version]
@@ -83,8 +77,6 @@ dependencies = [
8377
"black>=24.8.0",
8478
"mypy>=1.11.2",
8579
"ruff>=0.6.4",
86-
"numpy>=1.20",
87-
"zhinst-comms~=3.0",
8880
]
8981

9082
[tool.hatch.envs.lint.scripts]

src/labone/__init__.py

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
"""Official package for the Zurich Instruments LabOne software."""
1+
"""Deprecated package for the Zurich Instruments LabOne software.
22
3-
from labone._version import __version__ # type: ignore[import]
4-
from labone.core import ListNodesFlags
5-
from labone.dataserver import DataServer
6-
from labone.instrument import Instrument
3+
The `labone` package has been removed for the time being.
4+
Please refer to [zhinst-toolkit](https://pypi.org/project/zhinst-toolkit/)
5+
for the latest LabOne Python API.
6+
"""
77

8-
__all__ = [
9-
"DataServer",
10-
"Instrument",
11-
"ListNodesFlags",
12-
"__version__",
13-
]
8+
msg = """The `labone` package has been removed for the time being.
9+
Please refer to [zhinst-toolkit](https://pypi.org/project/zhinst-toolkit/)
10+
for the latest LabOne Python API."""
11+
raise ImportError(msg)

src/labone/core/__init__.py

Lines changed: 0 additions & 41 deletions
This file was deleted.

0 commit comments

Comments
 (0)