Skip to content

Comments

Small update in installation instructions#778

Merged
enyanil merged 4 commits intomasterfrom
enya/install_doc_update
Feb 17, 2026
Merged

Small update in installation instructions#778
enyanil merged 4 commits intomasterfrom
enya/install_doc_update

Conversation

@enyanil
Copy link
Member

@enyanil enyanil commented Feb 10, 2026

Added uv and updated pip. Clarified what is for regular usage or development.

@ArisMorgens
Copy link
Member

Looks good! Should we also add the one-time usage option using uvx cfclient?
This way, it creates a temporary virtual environment and installs the cfclient that is then "thrown away" once closed.

Copy link
Member

@ataffanel ataffanel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the Venv situation needs to be a bit more documented.


```bash
pip install cfclient
pip3 install cfclient
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This, and the UV version, requires a VENV to be created on all modern Python environment, this should also be documented I guess (and the start of the file mofidied to change venv from recomended to mandatory).

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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we advise uv since it does work much better than raw pip. It does need to be installed though.

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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For regular use, maybe documenting uvx cfclient is a good option since it does not require to setup a separate venv just to run the client?

Copy link
Member

@ataffanel ataffanel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have a last nit about the description of UVX, otherwise this is a great improvement.

@enyanil enyanil merged commit f0fd99d into master Feb 17, 2026
1 check passed
@enyanil enyanil deleted the enya/install_doc_update branch February 17, 2026 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants