Skip to content

Commit 0a52110

Browse files
committed
bump version for PyPI release
1 parent 801777e commit 0a52110

File tree

5 files changed

+65
-42
lines changed

5 files changed

+65
-42
lines changed

README.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The program works on **Linux**, **macOS**, and **Windows**. If you encounter pro
88

99
## Screenshots & Videos
1010

11-
[<img title="AVP running on Windows" alt="Screenshot of program on Windows" src="screenshot.png" width="707">](/screenshot.png?raw=true)
11+
[![Screenshot of AVP running on Windows](/screenshot.png?raw=true)](https://tassaron.com/img/avp/screenshot-v2.0.0.png)
1212

1313
### A video created by this app
1414

@@ -35,30 +35,27 @@ The program works on **Linux**, **macOS**, and **Windows**. If you encounter pro
3535
- On Ubuntu: `sudo apt install pipx`
3636
- On Arch: `sudo pacman -S python-pipx`
3737
- Run `pipx ensurepath` then close and reopen the terminal
38-
- Download and install this program: `pipx install git+https://github.com/djfun/audio-visualizer-python`
39-
- Or you can [download manually](https://github.com/djfun/audio-visualizer-python/releases/latest) and run `pipx install .` in this directory
38+
- Install latest stable version: `pipx install audio-visualizer-python`
4039
- Run this program with `avp` or `python -m avp` from terminal
4140

4241
### Using a Python virtual environment
4342

4443
- **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`
4746
- 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`
5149

5250
## Installation on Windows
5351

5452
- Install Python from the Windows Store
5553
- Add Python to your system PATH (it should ask during the installation process)
5654
- [PATH](<https://en.wikipedia.org/wiki/PATH_(variable)>) is where your computer looks for programs
57-
- Download this repo (extract from zip if needed)
5855
- Download and install [FFmpeg](https://www.ffmpeg.org/download.html). Use the GPL-licensed static builds.
5956
- Add FFmpeg to the system PATH as well (program will then work anywhere)
6057
- 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 prompt and run `pip install audio-visualizer-python`
6259
- Now run `avp` or `python -m avp` from a command prompt window to start the app
6360

6461
## Installation on macOS
@@ -87,11 +84,11 @@ The program works on **Linux**, **macOS**, and **Windows**. If you encounter pro
8784
| Ctrl+Shift+U | Open Undo History |
8885
| Ctrl+Shift+F | Show FFmpeg Command |
8986

90-
## Using commandline interface
87+
## Using Commandline Interface
9188

9289
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.
9390

94-
### Example command
91+
### Example Command
9592

9693
- Create a video with a grey "classic visualizer", background image, and text:
9794
- `avp -c 0 image path=src/tests/data/test.jpg -c 1 classic color=180,180,180 -c 2 text "title=Episode 371" -i src/tests/data/test.ogg -o output.mp4`
@@ -107,6 +104,15 @@ Projects can be created with the GUI then loaded from the commandline for easy a
107104
- Pillow 12.1.0
108105
- NumPy 2.4.1
109106

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.
114+
* `pip install -i https://test.pypi.org/simple/ audio-visualizer-python==x.x.x --extra-index-url https://pypi.org/simple numpy`
115+
110116
### Getting Faster Export Times
111117

112118
- [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).

pyproject.toml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ build-backend = "uv_build"
55
[project]
66
name = "audio-visualizer-python"
77
description = "Create audio visualization videos from a GUI or commandline"
8-
version = "2.1.2"
8+
readme = "README.md"
9+
version = "2.2.0"
910
requires-python = ">= 3.12"
1011
license = "MIT"
1112
classifiers=[
12-
"Development Status :: 4 - Beta",
13+
"Development Status :: 5 - Production/Stable",
1314
"License :: OSI Approved :: MIT License",
1415
"Programming Language :: Python :: 3 :: Only",
1516
"Intended Audience :: End Users/Desktop",
16-
"Topic :: Multimedia :: Video :: Non-Linear Editor",
17+
"Topic :: Multimedia :: Video",
1718
]
1819
keywords = [
1920
"visualizer",
2021
"visualization",
21-
"commandline video",
22-
"video editor",
22+
"fft",
2323
"ffmpeg",
2424
"podcast",
2525
]
@@ -30,10 +30,13 @@ authors = [
3030
{name = "HunterwolfAT", email = "hunterwolf0815@gmail.com"},
3131
{name = "rikai"},
3232
]
33+
maintainers = [
34+
{name = "Brianna Rainey", email = "brianna@tassaron.com"},
35+
]
3336
dependencies = [
34-
"numpy>=2.4.1",
35-
"pillow>=12.1.0",
36-
"pyqt6>=6.10.2",
37+
"numpy>=2.4.1",
38+
"pillow>=12.1.0",
39+
"pyqt6>=6.10.2",
3740
]
3841

3942
[dependency-groups]

src/avp/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import logging
44

55

6-
__version__ = "2.1.2"
6+
__version__ = "2.2.0"
77

88

99
class Logger(logging.getLoggerClass()):

tests/test_version.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
from avp import __version__
2+
from tomllib import load
3+
import os
4+
5+
6+
def test_version_number_matches():
7+
with open(
8+
os.path.join(
9+
os.path.dirname(os.path.realpath(__file__)), "..", "pyproject.toml"
10+
),
11+
"rb",
12+
) as fp:
13+
config = load(fp)
14+
assert config["project"]["version"] == __version__

uv.lock

Lines changed: 21 additions & 21 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)