.. _installation:

Installation
============

.. role:: shell(code)
  :language: shell


Released Versions
-----------------
It is **recommended to use released versions**, as they are fully tested and considered stable.
The UDS package is distributed via `PyPI <https://pypi.org/project/py-uds/>`_, where you can find
all available versions and distribution details.

- To install the package, run:

  :shell:`pip install py-uds`

- To upgrade to the latest release, run:

  :shell:`pip install -U py-uds`


Development Version
-------------------
If you would like to test features under development, you can install the latest code from the
`main` branch of the `GitHub repository <https://github.com/mdabrowski1990/uds>`_:

:shell:`pip install git+https://github.com/mdabrowski1990/uds.git@main`

.. warning:: The development version may be unstable. Use it at your own risk.