Skip to content

Commit 5cb04a2

Browse files
committed
[dist] Ensure python3 -m build works by default
Include pre-built documentation with distribution and improve error messaging when Tkinter is not available. Simplify download page and recommend pipx. This is now the tagged release for v1.6.2 however no changes to the Python or Windows distributions has been made, the only difference is for the source distribution here on Github and in the releases branch.
1 parent c4b898f commit 5cb04a2

File tree

15 files changed

+5255
-15
lines changed

15 files changed

+5255
-15
lines changed

.github/workflows/update-site.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ jobs:
3131
3232
- name: Generate Website
3333
run: |
34+
git rm docs/index_docs.md
3435
mkdocs build -f website/mkdocs.yml
36+
git reset --hard HEAD
3537
3638
- name: Update Website
3739
run: |

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@ dist/dvr-scan/*
1212
dist/dvr-scan-*
1313
dist/dvr_scan-*
1414

15-
# Location where docs are built before assembling distributions
16-
dvr_scan/docs/
17-
1815
# Editors/environment
1916
.DS_Store
2017
.vs_code/

docs/download.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,24 @@ hide:
66

77

88
# :fontawesome-solid-download:Download
9+
910
-------------------------------
1011

1112
## Python <span class="dvr-scan-download-icons">:fontawesome-brands-windows::fontawesome-brands-apple::fontawesome-brands-linux:</span>
1213

1314
!!! python-download "**1.6.2**<span class="dvr-scan-release-date">December 17, 2024</span>"
1415

15-
<h3>Regular Install:</h3>
16+
<h3>pipx (recommended):</h3>
17+
18+
pipx install dvr-scan[opencv]
1619

17-
pip install dvr-scan[opencv]==1.6.2
20+
<h3>pip:</h3>
1821

19-
<h3>Headless (Servers):</h3>
22+
python3 -m pip install dvr-scan[opencv]
2023

21-
pip install dvr-scan[opencv-headless]==1.6.2
24+
DVR-Scan requires Python 3.8 or higher to run, and works on Windows, Linux, and OSX. [`pipx` is recommended](https://pipx.pypa.io/stable/installation/) for installing DVR-Scan, however installing via `pip` or from source is also supported.
2225

23-
DVR-Scan works on Windows, Linux, and OSX, and requires Python 3.8 or higher. Linux users may need to install the `python3-tk` package (e.g. `sudo apt-get install python3-tk`) to run the region editor.
26+
Linux users may need to install the `python3-tk` package (e.g. `sudo apt install python3-tk`) to run the region editor.
2427

2528
-------------------------------
2629

@@ -33,22 +36,28 @@ DVR-Scan works on Windows, Linux, and OSX, and requires Python 3.8 or higher. Li
3336

3437
The installer is recommended for most users. Windows builds include all required dependencies to run DVR-Scan. Only 64-bit builds are available.
3538

39+
-------------------------------
40+
41+
## Servers and Headless Systems
42+
43+
For installation on servers and other headless systems that do not require a GUI, install `dvr-scan[opencv-headless]` instead of `dvr-scan[opencv]`. This will make sure that [the headless version of OpenCV](https://pypi.org/project/opencv-python-headless/) is installed, which avoids any dependencies on X11 libraries or any other GUI components. This allows DVR-Scan to run with less dependencies, and can result in smaller Docker images.
3644

3745
-------------------------------
3846

47+
## Source
3948

40-
<h3>CUDA®-Enabled Builds (Experimental)</h3>
49+
The source code for [DVR-Scan is available on Github](https://github.com/Breakthrough/DVR-Scan). It can be run directly from source (`python -m dvr_scan`), or built locally (`python -m build`).
4150

42-
GPU support currently requires a development environment setup including the Nvidia CUDA® SDK.
51+
-------------------------------
4352

44-
DVR-Scan works with CUDA graphics cards if you are using the Python distribution, and you have a CUDA-enabled verison of the `opencv-python` package. Unfortunately pre-built binaries are not available, so this requires that you build from source (there are various tutorials online for how to do this).
4553

46-
When available, you should see `cv2.cuda: Installed` under the features list when running `dvr-scan --version`. Make sure to set `-b MOG2_CUDA` when running DVR-Scan (e.g. `dvr-scan -i video.mp4 -b MOG2_CUDA`).
54+
## CUDA®-Enabled Builds
4755

56+
GPU support currently requires a development environment setup including the Nvidia CUDA® SDK.
4857

49-
## Source
58+
DVR-Scan works with CUDA graphics cards if you are using the Python distribution, and you have a CUDA-enabled verison of the `opencv-python` package. Unfortunately pre-built binaries are not available, so this requires that you build from source (there are various tutorials online for how to do this).
5059

51-
The source code for [DVR-Scan is available on Github](https://github.com/Breakthrough/DVR-Scan). It can be run directly from source (`python -m dvr_scan`), or built locally (`python -m build`).
60+
When available, you should see `cv2.cuda: Installed` under the features list when running `dvr-scan --version`. Make sure to set `-b MOG2_CUDA` when running DVR-Scan (e.g. `dvr-scan -i video.mp4 -b MOG2_CUDA`).
5261

5362
-------------------------------
5463

0 commit comments

Comments
 (0)