From 23028ccc92d1d8ec18a96e98123c4811e845b0f5 Mon Sep 17 00:00:00 2001 From: Enya Date: Tue, 10 Feb 2026 08:55:30 +0100 Subject: [PATCH 1/4] updated installation instructions --- docs/installation/install.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/installation/install.md b/docs/installation/install.md index 5c8e3cd7..1a96bec1 100644 --- a/docs/installation/install.md +++ b/docs/installation/install.md @@ -63,12 +63,19 @@ USB permissions need to be set as described above for Ubuntu/Linux. ## Installation Methods -### From PyPI (Recommended) +Choose the installation method that fits your use case: -If you plan to use the client to control the Crazyflie, we highly recommend installing the latest release using pip, as this is well tested and stable: +- **For regular use**: Install from PyPI using either `pip` or `uv` (both work equally well) +- **For development**: Install from source + +### From PyPI (Recommended, Regular Use) + +If you plan to use the client to control the Crazyflie, install the latest stable release from PyPI. Both `pip` and `uv` are equally good options: + +#### Using pip ```bash -pip install cfclient +pip3 install cfclient ``` For macOS specifically: @@ -76,6 +83,12 @@ For macOS specifically: python3 -m pip install cfclient ``` +#### Or, using uv + +```bash +uv pip install cfclient +``` + The client can then be launched from a console with `cfclient` or `python3 -m cfclient.gui`. ### From Source (Development) From 98212c280fd2594c532f785acbc124c868ff90c8 Mon Sep 17 00:00:00 2001 From: Enya Date: Thu, 12 Feb 2026 14:35:59 +0100 Subject: [PATCH 2/4] updated installation instructions --- docs/installation/install.md | 61 +++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 26 deletions(-) diff --git a/docs/installation/install.md b/docs/installation/install.md index 1a96bec1..8c95e59e 100644 --- a/docs/installation/install.md +++ b/docs/installation/install.md @@ -7,8 +7,6 @@ page_id: install This project requires Python 3.10+. -> **Recommendation**: Use a Python virtual environment to isolate dependencies. See the [official Python venv documentation](https://docs.python.org/3/library/venv.html) for setup instructions. - ## Platform Prerequisites ### Ubuntu/Linux @@ -61,37 +59,48 @@ The client requires Raspberry Pi Trixie or more recent. On Raspberry Pi Trixie i USB permissions need to be set as described above for Ubuntu/Linux. -## Installation Methods - -Choose the installation method that fits your use case: - -- **For regular use**: Install from PyPI using either `pip` or `uv` (both work equally well) -- **For development**: Install from source +## Installation -### From PyPI (Recommended, Regular Use) +#### Which method should I choose? +- **Just trying it out?** Use the Quick Start with `uvx`. +- **Regular user?** Use Standard Installation. +- **Developer?** Use Development Installation. -If you plan to use the client to control the Crazyflie, install the latest stable release from PyPI. Both `pip` and `uv` are equally good options: +### Quick Start (Recommended) -#### Using pip - -```bash -pip3 install cfclient -``` +The easiest way to run the client is with `uvx`, which automatically handles installation in a temporary environment: -For macOS specifically: +1. Install `uv` by following the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/). +2. Run the client: ```bash -python3 -m pip install cfclient + uvx cfclient ``` -#### Or, using uv - -```bash -uv pip install cfclient -``` - -The client can then be launched from a console with `cfclient` or `python3 -m cfclient.gui`. - -### From Source (Development) +This method requires no manual installation or virtual environment setup. The client runs directly and cleans up afterward. + +### Standard Installation + +For regular use or if you prefer a permanent installation, install from PyPI using `pip`. + +1. Create and activate a Python virtual environment to isolate dependencies. See the [official Python venv documentation](https://docs.python.org/3/library/venv.html) for setup instructions. +2. Install the client using pip, either by running: + ```bash + pip install cfclient + ``` + or, for macOS specifically: + ```bash + python3 -m pip install cfclient + ``` +3. After installation, run the client with: + ```bash + cfclient + ``` + or + ```bash + python3 -m cfclient.gui + ``` + +### Development Installation (From Source) If you are planning to do development work with the cfclient, install from source. From 9d6544bb2ff303d4afe93e828038f35e7abbdb7f Mon Sep 17 00:00:00 2001 From: Enya Date: Thu, 12 Feb 2026 14:57:42 +0100 Subject: [PATCH 3/4] development install instructions --- docs/installation/install.md | 34 +++++++++++++++++++--------------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/installation/install.md b/docs/installation/install.md index 8c95e59e..f81db26b 100644 --- a/docs/installation/install.md +++ b/docs/installation/install.md @@ -104,23 +104,27 @@ For regular use or if you prefer a permanent installation, install from PyPI usi If you are planning to do development work with the cfclient, install from source. -#### Clone the repository -```bash -git clone https://github.com/bitcraze/crazyflie-clients-python -cd crazyflie-clients-python -``` +1. Clone the repository -#### Install the client from source - -For basic installation: -```bash -pip install -e . -``` + ```bash + git clone https://github.com/bitcraze/crazyflie-clients-python + cd crazyflie-clients-python + ``` +2. Create and activate a Python virtual environment to isolate dependencies. See the [official Python venv documentation](https://docs.python.org/3/library/venv.html) for setup instructions. +3. Install the client from source -For development (includes additional tools): -```bash -pip install -e .[dev] -``` + For basic installation: + ```bash + pip install -e . + ``` + For development (includes additional tools): + ```bash + pip install -e .[dev] + ``` +4. After installation, run the client with: + ```bash + cfclient + ``` **Note**: Avoid running pip with sudo, as this would install dependencies system-wide and could cause compatibility problems. If pip requests administrator password, you should run the command with `--user` (for example `python3 -m pip install --user -e .`). This should not be required on modern Python distributions though since the `--user` flag seems to be the default behavior. From 5dc87466df8c3dc11a97c10fd78de17c2d9ff407 Mon Sep 17 00:00:00 2001 From: Enya Date: Tue, 17 Feb 2026 08:21:53 +0100 Subject: [PATCH 4/4] update about temp env --- docs/installation/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/install.md b/docs/installation/install.md index f81db26b..c8459de3 100644 --- a/docs/installation/install.md +++ b/docs/installation/install.md @@ -68,7 +68,7 @@ USB permissions need to be set as described above for Ubuntu/Linux. ### Quick Start (Recommended) -The easiest way to run the client is with `uvx`, which automatically handles installation in a temporary environment: +The easiest way to run the client is with `uvx`, which automatically handles installation and always runs the latest version: 1. Install `uv` by following the [official installation guide](https://docs.astral.sh/uv/getting-started/installation/). 2. Run the client: