.. _sardana-python-api-overview:

Python API overview
===================

Use this page to find Sardana's public extension and integration APIs by
purpose. For the exhaustive package and module tree, see the
:doc:`Python package reference <sardana/sardana>`.

Extension APIs
--------------

* :doc:`Macro API <api_macro>` -- classes, decorators and parameter types for
  writing macros.
* :doc:`Controller API <api_controller>` -- controller base classes,
  parameters and data types.
* :doc:`Recorder API <../recorder_api>` -- interfaces for writing scan data
  recorders.

Element APIs
------------

* :doc:`Motor <api_motor>`
* :doc:`I/O register <api_IOR>`
* :doc:`Counter/timer <api_countertimer>`
* :doc:`0D experiment channel <api_0D>`
* :doc:`1D experiment channel <api_1D>`
* :doc:`2D experiment channel <api_2D>`
* :doc:`Trigger/gate <api_triggergate>`
* :doc:`Pseudo motor <api_pseudomotor>`
* :doc:`Pseudo counter <api_pseudocounter>`
* :doc:`Measurement group <api_measurementgroup>`
* :doc:`MacroServer <api_macroserver>`
* :doc:`Pool <api_pool>`

Client integration APIs
-----------------------

* :doc:`Sardana-Taurus model API <sardana/taurus/core/tango/sardana>`
* :doc:`Sardana-Taurus Qt model API <sardana/taurus/qt/qtcore/tango/sardana>`

Testing and implementation details
----------------------------------

* :doc:`Test API <api_test>` -- test framework utilities and base classes.
* :doc:`Python package reference <sardana/sardana>` -- packages, modules and
  links to their implementation source.