Skip to content

Commit 5da893f

Browse files
committed
Update README.md
* Adds uv instructions * Update minimum supported Python version * Temporarily remove redundant installing from source instructions
1 parent d8694f1 commit 5da893f

1 file changed

Lines changed: 26 additions & 18 deletions

File tree

README.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,58 +21,66 @@ Features:
2121

2222
The following software must be installed for `pymusiclooper` to function correctly.
2323

24-
- [Python (64-bit)](https://www.python.org/downloads/) >= 3.9
24+
- [Python (64-bit)](https://www.python.org/downloads/) >=3.10
2525
- [ffmpeg](https://ffmpeg.org/download.html): required for loading audio from youtube (or any stream supported by [yt-dlp](https://github.com/yt-dlp/yt-dlp)) and adds support for loading additional audio formats and codecs such as M4A/AAC, Apple Lossless (ALAC), WMA, ATRAC (.at9), etc. A full list can be found at [ffmpeg's documentation](https://www.ffmpeg.org/general.html#Audio-Codecs). If the aforementioned features are not required, can be skipped.
2626

2727
Supported audio formats *without* ffmpeg include: WAV, FLAC, Ogg/Vorbis, Ogg/Opus, MP3.
2828
A full list can be found at [libsndfile's supported formats page](https://libsndfile.github.io/libsndfile/formats.html)
2929

3030
## Installation
3131

32-
### Option 1: Installing using pipx [Recommended]
32+
### Option 1: Installing using uv [Recommended]
3333

3434
This method of installation is strongly recommended, as it isolates PyMusicLooper's dependencies from the rest of your environment,
3535
and as a result, avoids dependency conflicts and breakage due to other packages.
3636

37-
Required python packages: [`pipx`](https://pypa.github.io/pipx/) (can be installed using `pip install pipx` ).
37+
Required tool: [`uv`](https://github.com/astral-sh/uv).
38+
Note: python is not required, as `uv` automatically installs this package's required python version automatically if not present.
3839

3940
```sh
4041
# Normal install
4142
# (follows the official releases on https://pypi.org/project/pymusiclooper/)
42-
pipx install pymusiclooper
43+
uv tool install pymusiclooper
4344

4445
# Alternative install
4546
# (follows the git repository; equivalent to a nightly release channel)
46-
pipx install git+https://github.com/arkrow/PyMusicLooper.git
47+
uv tool install git+https://github.com/arkrow/PyMusicLooper.git
4748

4849
# Updating to new releases in either case can be done simply using:
49-
pipx upgrade pymusiclooper
50+
uv tool upgrade pymusiclooper
5051
```
5152

52-
### Option 2: Installing using pip
53+
### Option 2: Installing using pipx
5354

54-
Traditional package installation method.
55+
Like `uv`, isolates PyMusicLooper's dependencies from the rest of your environment,
56+
and as a result, avoids dependency conflicts and breakage due to other packages.
57+
However, unlike `uv`, requires python to already be installed along with `pipx`.
5558

56-
*Note: fragile compared to an installation using `pipx`. PyMusicLooper may suddenly stop working if its dependencies were overwritten by another package (e.g. [issue #12](https://github.com/arkrow/PyMusicLooper/issues/12)).*
59+
Required python packages: [`pipx`](https://pypa.github.io/pipx/) (can be installed using `pip install pipx` ).
5760

5861
```sh
59-
pip install pymusiclooper
60-
```
62+
# Normal install
63+
# (follows the official releases on https://pypi.org/project/pymusiclooper/)
64+
pipx install pymusiclooper
6165

62-
### Option 3: Installing directly from source
66+
# Alternative install
67+
# (follows the git repository; equivalent to a nightly release channel)
68+
pipx install git+https://github.com/arkrow/PyMusicLooper.git
6369

64-
Required python packages: `pip` and [`poetry`](https://python-poetry.org/).
70+
# Updating to new releases in either case can be done simply using:
71+
pipx upgrade pymusiclooper
72+
```
73+
74+
### Option 3: Installing using pip
6575

66-
Clone the git repository to a directory of your choice and `cd` to inside the repo.
76+
Traditional package installation method.
6777

68-
Then, run:
78+
*Note: fragile compared to an installation using `uv` or `pipx`. PyMusicLooper may suddenly stop working if its dependencies were overwritten by another package (e.g. [issue #12](https://github.com/arkrow/PyMusicLooper/issues/12)).*
6979

7080
```sh
71-
poetry install
81+
pip install pymusiclooper
7282
```
7383

74-
A virtual environment can be setup through poetry by invoking the `poetry shell` command before installing.
75-
7684
## Available Commands
7785

7886
![pymusiclooper --help](https://github.com/arkrow/PyMusicLooper/raw/master/img/pymusiclooper.svg)

0 commit comments

Comments
 (0)