Skip to content

Installation

Install pyhulaX like a normal Python package.

Base Package

pip install pyhulaX

That gives you the core SDK:

Optional Extras

Install only the optional layers you need:

pip install "pyhulaX[video]"
pip install "pyhulaX[vision]"
pip install "pyhulaX[web]"
pip install "pyhulaX[db]"
pip install "pyhulaX[all]"

What they add:

  • video: RTP/RTSP streaming, display, recording helpers
  • vision: ONNX- and model-backed detection helpers
  • web: browser streaming helpers
  • db: PostgreSQL-backed flight logging
  • all: installs every optional extra

Local Development Install

From the repo:

uv sync
uv run python -c "from droneapi import DroneAPI; print(DroneAPI)"

Editable install with pip-compatible tooling:

uv pip install -e .

Python Version

pyhulaX targets modern Python environments. This project exists partly because the original pyhula release was effectively stuck on Python 3.6 and Windows-only assumptions.

If you want a local Python 3.13 environment with uv and pyenv:

pyenv local 3.13.3
uv venv --python 3.13.3 .venv
source .venv/bin/activate
python -V

Verify the Install

Basic import check:

from droneapi import DroneAPI, DroneConfig, NetworkConfig
from pypack.core import Direction

config = DroneConfig(
    network=NetworkConfig(drone_ip="192.168.100.1")
)

drone = DroneAPI(config=config, enable_command_logging=False)
print(drone.default_ip)
print(Direction.FORWARD)

If you installed video extras, you can also verify the streaming layer imports:

from pypack.video import VideoStream, Frame, VideoDisplay

print(VideoStream, Frame, VideoDisplay)

If you installed database extras:

from pypack.logging import SQLiteLogger, PostgresLogger

print(SQLiteLogger, PostgresLogger)

Next Steps