Install from source⚓
Best option for trying latest patches(maybe experimental), forking for Pull Requests, or automatically installing all prerequisites(with a few exceptions).
When installing VidGear from source, FFmpeg is the only API specific prerequisites you need to install manually:
What about rest of the prerequisites?
Any other python prerequisites (Critical/API specific) will be automatically installed based on your OS/System specifications.
It strongly advised to upgrade to latest
pip before installing vidgear to avoid any undesired installation error(s).
There are two mechanisms to upgrade
You can use existing
pip to upgrade itself:
pip if not present
- Download the script, from https://bootstrap.pypa.io/get-pip.py.
- Open a terminal/command prompt,
cdto the folder containing the
get-pip.pyfile and run:
More details about this script can be found in pypa/get-pip’s README.
API Specific Prerequisites⚓
If you want to checkout the latest beta
testing branch , you can do so with the following commands:
This can be useful if you want to provide feedback for a new feature or bug fix in the
DO NOT clone or install any other branch other than
testing unless advised, as it is not tested with CI environments and possibly very unstable or unusable.
Installing vidgear with only selective dependencies
Starting with version
v0.2.2, you can now run any VidGear API by installing only just specific dependencies required by the API in use(except for some Core dependencies).
This is useful when you want to manually review, select and install minimal API-specific dependencies on bare-minimum vidgear from scratch on your system:
To clone and install bare-minimum vidgear without any dependencies do as follows:
Then, you must install Critical dependencies(if not already):
Finally, manually install your API-specific dependencies as required by your API(in use):
APIs Dependencies CamGear
VideoGear Based on CamGear or PiGear backend in use ScreenGear
WriteGear FFmpeg: See this doc ➶ StreamGear FFmpeg: See this doc ➶ NetGear
Stabilizer Class -
If you are using Windows, some of the commands given below, may not work out-of-the-box.
A quick solution may be to preface every Python command with
python -m like this:
And, If you don't have the privileges to the directory you're installing package. Then use
--user flag, that makes pip install packages in your home directory instead:
Or, If you're using
py as alias for installed python, then:
# clone the repository and get inside git clone https://github.com/abhiTronix/vidgear.git && cd vidgear # checkout the latest testing branch git checkout testing # Install latest stable release with all Core dependencies pip install -U .[core] # Or Install latest stable release with all Core & Asyncio dependencies pip install -U .[asyncio]
ensurepipmodule is missing/disabled on Ubuntu. Use
pipmethod only. ↩