Skip to content

Commit 9fa2c64

Browse files
committed
[docs] Update install instructions for new headless variant
1 parent 0092815 commit 9fa2c64

5 files changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ Video Cut Detection and Analysis Tool
2525

2626
**Quick Install**:
2727

28-
pip install scenedetect[opencv] --upgrade
28+
pip install scenedetect --upgrade # standard (depends on opencv-python)
29+
pip install scenedetect-headless --upgrade # headless servers (depends on opencv-python-headless)
2930

3031
Requires ffmpeg/mkvmerge for video splitting support. Windows builds (MSI installer/portable ZIP) can be found on [the download page](https://scenedetect.com/download/).
3132

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ PySceneDetect Documentation
88

99
Welcome to the PySceneDetect docs. The docs are split into two separate parts: one for the command-line interface (the `scenedetect` command) and another for the Python API (the `scenedetect` module).
1010

11-
You can install the latest release of PySceneDetect by running `pip install scenedetect[opencv]` or downloading the Windows build from `scenedetect.com/download <http://www.scenedetect.com/download/>`_. PySceneDetect requires `ffmpeg` or `mkvmerge` for video splitting support.
11+
You can install the latest release of PySceneDetect by running `pip install scenedetect` (or `pip install scenedetect-headless` on servers without GUI libraries), or by downloading the Windows build from `scenedetect.com/download <http://www.scenedetect.com/download/>`_. PySceneDetect requires `ffmpeg` or `mkvmerge` for video splitting support.
1212

1313
.. note::
1414

packaging/package-info.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Documentation: https://www.scenedetect.com/docs
2323

2424
Github Repo: https://github.com/Breakthrough/PySceneDetect/
2525

26-
Install: ``pip install --upgrade scenedetect[opencv]``
26+
Install: ``pip install --upgrade scenedetect`` (or ``scenedetect-headless`` for servers)
2727

2828
----------------------------------------------------------
2929

website/pages/download.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ PySceneDetect requires at least Python 3.10 or higher.
99
## Install via pip &nbsp; <span class="wy-text-neutral"><span class="fa fa-windows"></span> &nbsp; <span class="fa fa-linux"></span> &nbsp; <span class="fa fa-apple"></span></span></h3>
1010

1111
<div class="important">
12-
<h4 class="wy-text-neutral"><span class="fa fa-angle-double-down wy-text-info"></span> Including OpenCV (recommended):</h4>
13-
<h3 class="wy-text-neutral"><tt>pip install --upgrade scenedetect[opencv]</tt></h3>
14-
<h4 class="wy-text-neutral"><span class="fa fa-angle-down wy-text-info"></span> Including Headless OpenCV (servers):</h4>
15-
<h3 class="wy-text-neutral"><tt>pip install --upgrade scenedetect[opencv-headless]</tt></h3>
12+
<h4 class="wy-text-neutral"><span class="fa fa-angle-double-down wy-text-info"></span> Standard install (recommended):</h4>
13+
<h3 class="wy-text-neutral"><tt>pip install --upgrade scenedetect</tt></h3>
14+
<h4 class="wy-text-neutral"><span class="fa fa-angle-down wy-text-info"></span> Headless install (servers, no GUI libs):</h4>
15+
<h3 class="wy-text-neutral"><tt>pip install --upgrade scenedetect-headless</tt></h3>
1616
</div>
1717

18-
PySceneDetect is available via `pip` as [the `scenedetect` package](https://pypi.org/project/scenedetect/).
18+
PySceneDetect is available via `pip` as either [`scenedetect`](https://pypi.org/project/scenedetect/) (depends on `opencv-python`) or [`scenedetect-headless`](https://pypi.org/project/scenedetect-headless/) (depends on `opencv-python-headless`). Both ship the same `scenedetect` Python module — install whichever OpenCV variant suits your environment.
1919

2020
## Windows Build (64-bit Only) &nbsp; <span class="wy-text-neutral"><span class="fa fa-windows"></span></span>
2121

website/pages/faq.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,19 @@
44

55
#### How can I fix `ImportError: No module named cv2`?
66

7-
You need to install OpenCV for PySceneDetect to properly work. If you're using `pip`, you can install it as follows:
7+
As of PySceneDetect 0.7, the OpenCV dependency is bundled with the install. The standard `scenedetect` package depends on `opencv-python`:
88

99
```md
10-
pip install scenedetect[opencv]
10+
pip install scenedetect
1111
```
1212

13-
Note that you may need to use a different/older version depending on your Python version. You can also use the headless package if you're running a server:
14-
13+
For server environments without GUI libraries, install the headless variant instead, which depends on `opencv-python-headless`:
1514

1615
```md
17-
pip install scenedetect[opencv-headless]
16+
pip install scenedetect-headless
1817
```
1918

20-
Unlike calling `pip install opencv-python`, the above commands will download and install the correct OpenCV version based on the Python version you are running.
19+
Both packages ship the same `scenedetect` Python module — you only need one.
2120

2221
#### How can I enable video splitting support?
2322

0 commit comments

Comments
 (0)