Development
Installation
Clone the repository and navigate to the project directory:
git clone https://github.com/pyrtlsdr/pyrtlsdr.git
cd pyrtlsdr
Then install the package in one of two ways:
Using uv (recommended)
Install uv
Install uv (if you don’t have it already) by following the instructions on the uv installation page.
Use curl to download the installation script and run it with sh:
curl -LsSf https://astral.sh/uv/install.sh | sh
If your system doesn’t have curl, you can use wget instead:
wget -qO- https://astral.sh/uv/install.sh | sh
Use irm to download the script and execute it with iex:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
Changing the execution policy allows running a script from the internet.
Tip
The installation script may be inspected before running:
curl -LsSf https://astral.sh/uv/install.sh | less
powershell -c "irm https://astral.sh/uv/install.ps1 | more"
Alternatively, the installer or binaries can be downloaded directly from GitHub.
Install project
Choose the Python version you want to use (optional):
uv python pin 3.14
Then install the package (including development dependencies):
uv sync
Tip
uv will handle virtual environment creation and management, as well as Python version management,
and will install the package in editable mode by default.
You can also use uv to run tests and other commands (see the uv cli documentation for more details).
Using pip
Note
The instructions below assume you have already set up a virtual environment, and have activated it before running the commands.
Install the project
Install with pip in editable mode:
pip install -e .
or to include the optional pyrtlsdrlib dependency:
pip install -e '.[lib]'
Install development dependencies
The development dependencies are listed in the dependency-groups sections of the pyproject.toml file.
Installation of these dependencies is optional, but may be required for running tests and building documentation.