Installation

This guide covers the various methods for installing pydoover on your system.

• Python 3.11 or higher is required
• A package manager (pip, uv, or apt)

uv is a fast Python package installer. To add pydoover to your project:

uv add pydoover

Install or upgrade pydoover using pip:

pip install -U pydoover

For Debian-based systems, you can install pydoover using apt:

sudo apt install doover-pydoover

pydoover provides optional dependency groups for specific functionality.

For applications requiring gRPC communication, install the grpc extras:

pip install -U pydoover[grpc]

This installs:

• grpcio==1.65.1
• protobuf==5.28.2

For applications that generate reports, install the reports extras:

pip install -U pydoover[reports]

This installs:

• pytz
• tzlocal
• xlsxwriter

You can install multiple extras at once:

pip install -U pydoover[grpc,reports]

pydoover automatically installs the following core dependencies:

After installation, verify that pydoover is correctly installed by checking the version:

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

You should see 0.4.18 (or the current version) printed to the console.

pydoover includes a command-line interface for interacting with gRPC servers on devices:

pydoover --help

For application development workflows (creating, building, deploying apps), install the separate doover-cli package:

# Using uv (Recommended)
uv tool install doover-cli

# Using pipx
pipx install doover-cli

# Using pip
pip install doover-cli

After installation, the doover command is available:

doover --help

The Doover CLI provides commands for:

• doover app create - Scaffold new applications
• doover app run - Run applications locally with simulators
• doover app publish - Deploy applications to the Doover platform
• doover channel - Manage channels and messaging
• doover tunnel - Create SSH/HTTP tunnels to devices

See the Doover CLI documentation for complete details.

Once you have pydoover installed, proceed to the Quick Start Guide to build your first application.