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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
.. image:: https://gitlab.com/tango-controls/pytango/-/raw/9a45580eaaf453cd6dc12185ad951bbd214d6807/doc/_static/logo.png
:alt: PyTango logo
:align: center
:width: 70%
------------
|Doc Status|
|Gitlab Build Status|
|Gitlab Code Coverage|
|Pypi Version|
|Python Versions|
|Conda|
PyTango
=======
Main website: https://pytango.readthedocs.io
Python binding for Tango_, a library dedicated to distributed control systems.
Description
-----------
PyTango_ exposes the complete `Tango C++ API`_ through the ``tango`` python module.
It also adds a bit of abstraction by taking advantage of the Python capabilities:
- ``tango.client`` provides a client access to device servers and databases.
- ``tango.server`` provides base classes to declare and run device servers.
Requirements
------------
PyTango_ is compatible with python 3.10+.
General dependencies:
- cppTango_ >= 10.1.1, and its dependencies: omniORB4 and libzmq
Python dependencies:
- numpy_
- psutil_
- packaging_
- typing-extensions_
- docstring_parser_
Build dependencies:
- pypa-build_
- scikit-build-core_
- pybind11_ >= 3.0.0
- pybind11-stubgen_
Optional dependencies (telemetry):
- opentelemetry-api_
- opentelemetry-sdk_
- opentelemetry-exporter-otlp-proto-grpc_
- opentelemetry-exporter-otlp-proto-http_
Optional dependencies (test):
- gevent_
- pytest_
- pytest-forked_
- pytest-cov_
- pytest-asyncio_
.. note:: As a general rule, cppTango_ and pytango_ should share the same major
and minor version (for a version ``X.Y.Z``, ``X`` and ``Y`` should
match).
On some systems you may need to install ``omniORB4`` and ``libzmq`` related
development packages.
Install
-------
PyTango_ is available on PyPI_ as ``pytango``, with pre-built binaries for some platforms
(you need pip>=19.3, so upgrade first if necessary)::
$ python -m pip install --upgrade pip
$ python -m pip install pytango
Alternatively, pre-built PyTango_ binaries can be installed from `Conda Forge_`::
$ conda install -c conda-forge pytango
For the very latest code, or for development purposes, PyTango_ can be built and installed from the
`sources`_. This is complicated by the dependencies - see the Getting Started section in the documentation_.
Usage
-----
To test the installation, import ``tango`` and check ``tango.utils.info()``::
>>> import tango
>>> import tango; print(tango.utils.info())
PyTango 10.1.1 (10, 1, 1)
PyTango compiled with:
Python : 3.14.0
Numpy : 2.3.4
Tango : 10.1.1
pybind11 : 3.0.1
PyTango runtime is:
Python : 3.14.0
Numpy : 2.3.4
Tango : 10.1.1
PyTango running on:
uname_result(system='Linux', node='debian', release='5.10.0-35-amd64', version='#1 SMP Debian 5.10.237-1 (2025-05-19)', machine='x86_64')
For an interactive use, consider using ITango_, a tango IPython_ profile.
Documentation
-------------
Check out the documentation_ for more information.
Support and contribution
------------------------
You can get support from the `Tango forums`_, for both Tango_ and PyTango_ questions.
All contributions, `MR and bug reports`_ are welcome, please see: `How to Contribute`_ !
.. |Doc Status| image:: https://readthedocs.org/projects/pytango/badge/?version=latest
:target: https://pytango.readthedocs.io/en/latest
:alt:
.. |Gitlab Build Status| image:: https://img.shields.io/gitlab/pipeline-status/tango-controls/pytango?branch=develop&label=develop
:target: https://gitlab.com/tango-controls/pytango/-/pipelines?page=1&scope=branches&ref=develop
:alt:
.. |Gitlab code coverage| image:: https://img.shields.io/gitlab/pipeline-coverage/tango-controls/pytango.svg?branch=develop
:target: https://gitlab.com/tango-controls/pytango/-/pipelines?page=1&scope=branches&ref=develop
:alt:
.. |Pypi Version| image:: https://img.shields.io/pypi/v/PyTango.svg
:target: https://pypi.org/project/PyTango
:alt:
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/PyTango.svg
:target: https://pypi.org/project/PyTango/
:alt:
.. |Conda| image:: https://img.shields.io/conda/v/conda-forge/pytango
:target: https://anaconda.org/conda-forge/pytango
:alt:
.. _Tango: https://tango-controls.org
.. _Tango C++ API: https://tango-controls.github.io/cppTango-docs/index.html
.. _PyTango: https://gitlab.com/tango-controls/pytango
.. _PyPI: https://pypi.org/project/pytango
.. _Conda Forge: https://anaconda.org/conda-forge/pytango
.. _scikit-build-core: https://github.com/scikit-build/scikit-build-core
.. _pybind11-stubgen: https://pypi.org/project/pybind11-stubgen/
.. _pypa-build: https://github.com/pypa/build
.. _cppTango: https://gitlab.com/tango-controls/cppTango
.. _pybind11: https://github.com/pybind/pybind11
.. _numpy: https://pypi.org/project/numpy
.. _packaging: https://pypi.org/project/packaging
.. _psutil: https://pypi.org/project/psutil
.. _typing-extensions: https://pypi.org/project/typing_extensions
.. _opentelemetry-api: https://pypi.org/project/opentelemetry-api
.. _opentelemetry-sdk: https://pypi.org/project/opentelemetry-sdk
.. _opentelemetry-exporter-otlp-proto-grpc: https://pypi.org/project/opentelemetry-exporter-otlp-proto-grpc
.. _opentelemetry-exporter-otlp-proto-http: https://pypi.org/project/opentelemetry-exporter-otlp-proto-http
.. _gevent: https://pypi.org/project/gevent
.. _pytest: https://docs.pytest.org/en/latest/
.. _pytest-forked: https://github.com/pytest-dev/pytest-forked
.. _pytest-cov: https://github.com/pytest-dev/pytest-cov
.. _pytest-asyncio: https://github.com/pytest-dev/pytest-asyncio
.. _docstring_parser: https://github.com/rr-/docstring_parser
.. _ITango: https://pypi.org/project/itango/
.. _IPython: https://ipython.org
.. _documentation: https://pytango.readthedocs.io/en/latest
.. _Tango forums: https://tango-controls.org/community/forum
.. _MR and bug reports: PyTango_
.. _sources: PyTango_
.. _How to Contribute: https://pytango.readthedocs.io/en/latest/how-to-contribute.html#how-to-contribute
|
