You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Run this program with `avp` or `python -m avp` from terminal
41
40
42
41
### Using a Python virtual environment
43
42
44
43
-**This is a good method if you want to edit the code**
45
-
- Make a virtual environment: `python -m venv env`
46
-
- Activate it: `source env/bin/activate`
44
+
- Make a virtual environment: `python -m venv .venv`
45
+
- Activate it: `source .venv/bin/activate`
47
46
- Install uv: `pip install uv`
48
-
- Install this program by running `uv sync` in this directory
49
-
- Run program with `avp` or `python -m avp` or `uv run avp`
50
-
- Optional: Tests can be run with `uv run pytest`
47
+
- Install this program: `uv sync` in this directory
48
+
- Run program with `avp` or `python -m avp`
51
49
52
50
## Installation on Windows
53
51
54
52
- Install Python from the Windows Store
55
53
- Add Python to your system PATH (it should ask during the installation process)
56
54
-[PATH](<https://en.wikipedia.org/wiki/PATH_(variable)>) is where your computer looks for programs
57
-
- Download this repo (extract from zip if needed)
58
55
- Download and install [FFmpeg](https://www.ffmpeg.org/download.html). Use the GPL-licensed static builds.
59
56
- Add FFmpeg to the system PATH as well (program will then work anywhere)
60
57
- Alternatively, copy ffmpeg.exe into the folder that you want to run the program within
61
-
- Open command prompt, `cd` into the repo directory, and run:`pip install .`
58
+
- Open command promptand run `pip install audio-visualizer-python`
62
59
- Now run `avp` or `python -m avp` from a command prompt window to start the app
63
60
64
61
## Installation on macOS
@@ -87,11 +84,11 @@ The program works on **Linux**, **macOS**, and **Windows**. If you encounter pro
87
84
| Ctrl+Shift+U | Open Undo History |
88
85
| Ctrl+Shift+F | Show FFmpeg Command |
89
86
90
-
## Using commandline interface
87
+
## Using Commandline Interface
91
88
92
89
Projects can be created with the GUI then loaded from the commandline for easy automation of video production. Some components have commandline options for extra customization, and you can save "presets" with settings to load if the commandline option doesn't exist.
93
90
94
-
### Example command
91
+
### Example Command
95
92
96
93
- Create a video with a grey "classic visualizer", background image, and text:
@@ -107,6 +104,15 @@ Projects can be created with the GUI then loaded from the commandline for easy a
107
104
- Pillow 12.1.0
108
105
- NumPy 2.4.1
109
106
107
+
### Running Automatic Tests
108
+
Run unit and integration tests with `pytest`.
109
+
* First you will need to install with `pip install pytest pytest-qt`
110
+
* You may omit the slowest test with `pytest -k "not commandline_export"`
111
+
112
+
### Installing from TestPyPI
113
+
Because some dependencies (namely numpy) are not always on TestPyPI, you must specify when installing that these dependencies should come from the real PyPI.
-[Pillow-SIMD](https://github.com/uploadcare/pillow-simd) may be used as a drop-in replacement for Pillow if you desire faster video export times, but it must be compiled from source. For help installing dependencies to compile Pillow-SIMD, see the [Pillow installation guide](https://pillow.readthedocs.io/en/stable/installation/building-from-source.html).
0 commit comments