forked from jeanslack/Videomass
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathINSTALL
182 lines (116 loc) · 4.84 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
VIDEOMASS INSTALLATION INSTRUCTIONS AND BUILDINGS
=============================
Base application dependencies
=============================
Requires:
- Python >=3.8.0 <=3.12.0
- wxPython-Phoenix >=4.0.7
- PyPubSub >=4.0.3
- requests >=2.26.0
- FFmpeg (included ffplay and ffprobe) >=5.1
Optionals:
- yt-dlp >=2024.04.09
=========================
Run from source directory
=========================
Videomass can be run without installing by extracting the source archive
and executing the "launcher" script inside the source Videomass directory.
cd Videomass (source directory)
python3 launcher
Videomass can also be imported from the Python3 console (interactive mode):
>>> from videomass import gui_app
>>> gui_app.main()
=====================================
Compiles language translation catalog
=====================================
By default Videomass does not include the compiled catalog for language
translations, i.e. `videomass.mo` files, especially on development source code.
If you want to compile the language catalog to make the translations available
on Videomass, use one of the following options based on your operating system
requirements:
Using `generate_MO_files.sh` shell script (only for Linux, FreeBSD, MacOs)
--------------------------------------------------------------------------
Requires:
- shell (/bin/bash)
- msgfmt (from GNU-gettext)
cd Videomass (source directory)
./develop/gettext_utils/generate_MO_files.sh
Using `babelutils.py` python script (multi-platform)
----------------------------------------------------
Requires:
- babel (also installable via pip)
cd Videomass (source directory)
python3 develop/gettext_utils/babelutils.py --compile-catalogs --output-dir videomass/data/locale --domain videomass
======================
Installation using pip
======================
Requires:
- Python >=3.8.0 <=3.12.0
- pip
- venv
Installing on Linux/FreeBSD:
----------------------------
IMPORTANT!
Before pip install Videomass make sure to install wxPython from your Linux
distribution's package manager. This will prevent pip from attempting to
build wxPython from source, as wxPython's PyPi wheels provides support for
Windows and MacOS only.
This assumes installation in a virtual environment using python3-venv
module with `--system-site-package` option, like this:
python3 -m venv --system-site-packages --upgrade-deps VENV
source VENV/bin/activate
To install videomass type:
python3 -m pip install videomass
Optionally install yt-dlp:
python3 -m pip install yt-dlp
Installing on Windows and MacOs:
--------------------------------
This assumes installation in a virtual environment using python3-venv
module, like this:
python -m venv --upgrade-deps VENV
source VENV/bin/activate
To install videomass type:
python3 -m pip install videomass
Optionally install yt-dlp:
python3 -m pip install yt-dlp
To Update on Windows, MacOs, Linux, FreeBSD:
--------------------------------------------
python3 -m pip install --upgrade videomass
To uninstall on Windows, MacOs, Linux, FreeBSD:
-----------------------------------------------
python3 -m pip uninstall videomass
Please, Visit the Wiki page for more info:
<https://github.com/jeanslack/Videomass/wiki/Installation-using-pip>
==============================
Build as standalone executable
==============================
This build a standalone executable package only compatible for the operating
system in use. The current supported OS are Windows, MacOs, Linux.
It is assumed that you are working on a virtual environment created with
the `venv` or `virtualenv` module and that you have installed the `Base
application dependencies` described at the beginning of this file.
Requires:
- pyinstaller
- babel
activate a virtual environment first
cd Videomass (source directory)
python3 -m pip install pyinstaller babel
Use the `pyinstaller_setup.py` script like this:
python3 develop/tools/pyinstaller_setup.py --gen-spec --build
=====================
Build sdist and wheel
=====================
Requires:
- hatchling
- build
- wheel
- babel
cd Videomass (source directory)
python3 -m build
For more info visit: <https://packaging.python.org/tutorials/packaging-projects/>
======================================================
Make a Debian source package from upstream source code
======================================================
This will transform upstream source code into policy-compliant binary packages.
Please, Visit the Videomass Wiki page for istructions:
<https://github.com/jeanslack/Videomass/wiki/Packaging-for-Debian-and-derivatives>