1. rcrnstn/zoommotion
  2. Commit 60a2b26e2fa74caec87889ede0c7c27bdaa0d0fd
Browse code

Add install

Robert Cranston authored on 18/01/2022 01:13:27
Showing 2 changed files
README.md
History View file @ 60a2b26
... ... 
@@ -4,6 +4,68 @@ Zoom in on video motion.
4 4
5 5 
 [`zoommotion`]: https://git.rcrnstn.net/rcrnstn/zoommotion
6 6
7 
+## Install
8 
+
9 
+Make sure [Python is installed][Python download], [`pip`][] is available and
10 
+the [`pip`][], [`setuptools`][] and [`wheel`][] packages are up to date:
11 
+
12 
+```sh
13 
+python3 -m pip install --user --upgrade pip setuptools wheel
14 
+```
15 
+
16 
+Reference: [Python Packaging User Guide: Requirements for Installing
17 
+Packages][].
18 
+
19 
+[Python download]: https://python.org/download
20 
+[`pip`]: https://pip.readthedocs.io
21 
+[`setuptools`]: https://setuptools.readthedocs.io
22 
+[`wheel`]: https://wheel.readthedocs.io
23 
+[Python Packaging User Guide: Requirements for Installing Packages]: https://packaging.python.org/tutorials/installing-packages/#requirements-for-installing-packages
24 
+
25 
+### With [`pipx`][], for users
26 
+
27 
+Make sure [`pipx`][] is installed:
28 
+
29 
+```sh
30 
+python3 -m pip install --user pipx
31 
+```
32 
+
33 
+Install `zoommotion`:
34 
+
35 
+```sh
36 
+pipx install "git+https://git.rcrnstn.net/rcrnstn/zoommotion"
37 
+```
38 
+
39 
+`zoommotion` should now be in your [`PATH`][] (if not, run `python3 -m pipx
40 
+ensurepath`).
41 
+
42 
+Reference: [Python Packaging User Guide: Installing stand alone command line
43 
+tools][].
44 
+
45 
+[`pipx`]: https://pipxproject.github.io/pipx/
46 
+[`PATH`]: https://en.wikipedia.org/wiki/PATH_(variable)
47 
+[Python Packaging User Guide: Installing stand alone command line tools]: https://packaging.python.org/guides/installing-stand-alone-command-line-tools/
48 
+
49 
+### Into [`venv`][], for developers
50 
+
51 
+Clone and install into a repository [`venv`][] virtual environment:
52 
+
53 
+```sh
54 
+git clone "https://git.rcrnstn.net/rcrnstn/zoommotion"
55 
+cd "zoommotion"
56 
+python3 -m venv .venv
57 
+. .venv/bin/activate
58 
+python3 -m pip install --editable .
59 
+```
60 
+
61 
+`zoommotion` should now be in your (virtual environment) [`PATH`][].
62 
+
63 
+Reference: [Python Packaging User Guide: Installing packages using pip and
64 
+virtual environments][].
65 
+
66 
+[`venv`]: https://docs.python.org/3/library/venv.html
67 
+[Python Packaging User Guide: Installing packages using pip and virtual environments]: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/
68 
+
7 69 
 ## License
8 70
9 71 
 Licensed under the [ISC License][] unless otherwise noted, see the
setup.py
History View file @ 60a2b26
10 72 
new file mode 100644
... ... 
@@ -0,0 +1,33 @@
1 
+from setuptools import setup
2 
+
3 
+with open("README.md") as f:
4 
+    long_description = f.read()
5 
+
6 
+setup(
7 
+    name='zoommotion',
8 
+    version='1.0.0',
9 
+    description="Automatically zoom in on video content of interest",
10 
+    long_description=long_description,
11 
+    long_description_content_type='text/markdown',
12 
+    url='https://git.rcrnstn.net/rcrnstn/zoommotion',
13 
+    author="Robert Cranston",
14 
+    keywords='ffmpeg opencv',
15 
+    classifiers=[
16 
+        'Programming Language :: Python :: 3',
17 
+        'License :: OSI Approved :: ISC License (ISCL)',
18 
+    ],
19 
+    python_requires='>=3, <4',
20 
+    install_requires=[
21 
+        'pyffstream @ git+https://git.rcrnstn.net/rcrnstn/pyffstream',
22 
+        'numpy',
23 
+        'Pillow',
24 
+        'opencv-python',
25 
+        'scipy',
26 
+    ],
27 
+    py_modules=['zoommotion'],
28 
+    entry_points={
29 
+        'console_scripts': [
30 
+            'zoommotion = zoommotion:main',
31 
+        ],
32 
+    },
33 
+)