From 237c4b69137cbd782bc9300d468882755c7e8ade Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niklas=20Kr=C3=B6ger?= Date: Wed, 20 Sep 2023 14:26:02 +0200 Subject: [PATCH 1/2] Expand `pip install` description - Add a link to the official docs for `pip install` - Add a note section that shows how to define the extras to install and points out the needed single quotes --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3209ead..67bc69d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ allowing for rapid development of applications. To use VmbPy an installation of Vimba X and Python >= 3.7 are required. A ready-to-install packaged `.whl` file of VmbPy can be found as part of the Vimba X installation, or be downloaded from our [github release page](https://github.com/alliedvision/VmbPy/releases). The `.whl` can be installed -as usual via the `pip install` command. +as usual via the [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/) command. ## Optional dependencies @@ -24,6 +24,13 @@ tools that are used in our full test suite. The following extras are defined for - test: Additional tools such as `flake8`, `mypy`, and `coverage` only necessary for executing `run_tests.py` +> [!NOTE] +> Installing these extra dependencies is possible by defining them as part of the installation +> command like so (note the single quotes around the filename and extras): +> ``` +> pip install '/path/to/vmbpy-X.Y.Z-py-none-any.whl[numpy,opencv]' +> ``` + ### Yocto on NXP i.MX8 and OpenCV The GPU in i.MX8 systems requires using the system-wide opencv-python package. When you create the From 26dec5716e922374819259e19e3755f64b3b86d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niklas=20Kr=C3=B6ger?= Date: Fri, 10 Nov 2023 10:26:03 +0100 Subject: [PATCH 2/2] Add note about possibility of command being `pip3` --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 67bc69d..9b2ce95 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ To use VmbPy an installation of Vimba X and Python >= 3.7 are required. A ready- [github release page](https://github.com/alliedvision/VmbPy/releases). The `.whl` can be installed as usual via the [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/) command. +> [!NOTE] +> Depending on the some systems the command might instead be called `pip3`. Check your systems +> Python documentation for details. + ## Optional dependencies For some functionality of VmbPy optional dependencies (also called "extras") are required. These