Skip to content

Installation

pydoover requires Python 3.11 or later. It has two core dependencies --- aiohttp (async HTTP) and httpx (sync HTTP) --- which are installed automatically.

Install from PyPI

The recommended way to install pydoover is from PyPI.

Using pip:

pip install pydoover

Using uv:

uv add pydoover

Install from source

To install the latest development version directly from GitHub:

pip install git+https://github.com/getdoover/pydoover.git

This is useful when you need a fix or feature that has not yet been published to PyPI.

Optional extras

pydoover ships optional dependency groups for specific use cases. Install them by appending the extra name in brackets.

gRPC support (device-side Docker apps)

Device-side applications communicate with the Doover Device Agent, Platform I/O, and Modbus services over gRPC. Install the grpc extra to pull in grpcio and protobuf:

pip install pydoover[grpc]
Information Circle

The grpc extra is only needed for Docker applications running on Doovit devices. Cloud processors and standalone API scripts do not require it.

Report generation

The report processor framework uses croniter for schedule parsing. Install the reports extra to enable it:

pip install pydoover[reports]

Combining extras

You can install multiple extras at once:

pip install pydoover[grpc,reports]

Install on Doovit devices via apt

Doovit devices can install pydoover from the Doover apt repository at apt.doover.com. This is the standard installation method for production edge deployments and is handled automatically by the Doover device provisioning process.

Information Circle

The apt package is pre-configured on Doovit hardware. You only need to use this method if you are manually provisioning a device or reinstalling the SDK.

Verify your installation

After installing, confirm that pydoover is available and check the installed version:

python -c "import pydoover; print(pydoover.__version__)"

You should see output like 1.0.0a13 (the exact version will depend on your install).

Doover CLI

The doover CLI is a companion command-line tool that wraps pydoover and provides commands for managing applications, devices, channels, and more. Install it separately:

pip install doover-cli

See the Doover CLI Overview for usage details.

Next steps

With pydoover installed, head to the Quick Start guide to build your first application.