@@ -9,14 +9,34 @@ collection better.
9
9
Installing
10
10
----------
11
11
12
- You will need Python.
13
- Beets works on Python 3.8 or later.
12
+ Beets requires Python 3.9 or later, you will need to install that first. Depending
13
+ on your operating system, you may also be able to install beets from a package
14
+ manager, or you can install it with `pip `_.
14
15
15
- * **macOS ** 11 (Big Sur) includes Python 3.8 out of the box.
16
- You can opt for a more recent Python installing it via `Homebrew `_
17
- (``brew install python3 ``).
18
- There's also a `MacPorts `_ port. Run ``port install beets `` or
19
- ``port install beets-full `` to include many third-party plugins.
16
+ Using pip
17
+ ^^^^^^^^^
18
+
19
+ To use the most recent version of beets, we recommend installing it with
20
+ `pip `_, the Python package manager. If you don't have `pip `_ installed, you can
21
+ follow the instructions on the `pip installation page `_ to get it set up.
22
+
23
+ .. code-block :: console
24
+
25
+ pip install beets
26
+ # or, to install for the current user only:
27
+ pip install --user beets
28
+
29
+
30
+ .. attention :: Python 3.13 not officially supported yet!
31
+
32
+ If you are using Python 3.13, please be aware that it is not yet officially supported yet.
33
+ You may encounter issues, and we recommend using Python 3.12 or earlier until support is confirmed.
34
+
35
+
36
+ Using a Package Manager
37
+ ^^^^^^^^^^^^^^^^^^^^^^^
38
+
39
+ Depending on your operating system, you may be able to install beets using a package manager. Here are some common options:
20
40
21
41
* On **Debian or Ubuntu **, depending on the version, beets is available as an
22
42
official package (`Debian details `_, `Ubuntu details `_), so try typing:
@@ -39,66 +59,30 @@ Beets works on Python 3.8 or later.
39
59
40
60
* On **FreeBSD **, there's a `beets port <FreeBSD _>`_ at ``audio/beets ``.
41
61
42
- * On **OpenBSD **, there's a `beets port <OpenBSD _>`_ can be installed with ``pkg_add beets ``.
43
-
44
- * For **Slackware **, there's a `SlackBuild `_ available.
45
-
46
62
* On **Fedora ** 22 or later, there's a `DNF package `_ you can install with ``sudo dnf install beets beets-plugins beets-doc ``.
47
63
48
64
* On **Solus **, run ``eopkg install beets ``.
49
65
50
66
* On **NixOS **, there's a `package <NixOS _>`_ you can install with ``nix-env -i beets ``.
51
67
52
68
.. _DNF package : https://packages.fedoraproject.org/pkgs/beets/
53
- .. _SlackBuild : https://slackbuilds.org/repository/14.2/multimedia/beets/
54
69
.. _FreeBSD : http://portsmon.freebsd.org/portoverview.py?category=audio&portname=beets
55
70
.. _AUR : https://aur.archlinux.org/packages/beets-git/
56
71
.. _Debian details : https://tracker.debian.org/pkg/beets
57
72
.. _Ubuntu details : https://launchpad.net/ubuntu/+source/beets
58
- .. _OpenBSD : http://openports.se/audio/beets
59
73
.. _Arch extra : https://archlinux.org/packages/extra/any/beets/
60
74
.. _Alpine package : https://pkgs.alpinelinux.org/package/edge/community/x86_64/beets
61
75
.. _NixOS : https://github.com/NixOS/nixpkgs/tree/master/pkgs/tools/audio/beets
62
- .. _MacPorts : https://www.macports.org
63
-
64
- If you have `pip `_, just say ``pip install beets `` (or ``pip install --user
65
- beets `` if you run into permissions problems).
66
-
67
- To install without pip, download beets from `its PyPI page `_ and run ``python
68
- setup.py install `` in the directory therein.
69
-
70
- .. _its PyPI page : https://pypi.org/project/beets/#files
71
- .. _pip : https://pip.pypa.io
72
-
73
- The best way to upgrade beets to a new version is by running ``pip install -U
74
- beets ``. You may want to follow `@b33ts `_ on Twitter to hear about progress on
75
- new versions.
76
-
77
- .. _@b33ts : https://twitter.com/b33ts
78
-
79
- Installing by Hand on macOS 10.11 and Higher
80
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
81
-
82
- Starting with version 10.11 (El Capitan), macOS has a new security feature
83
- called `System Integrity Protection `_ (SIP) that prevents you from modifying
84
- some parts of the system. This means that some ``pip `` commands may fail with a
85
- permissions error. (You probably *won't * run into this if you've installed
86
- Python yourself with `Homebrew `_ or otherwise. You can also try `MacPorts `_.)
87
-
88
- If this happens, you can install beets for the current user only by typing
89
- ``pip install --user beets ``. If you do that, you might want to add
90
- ``~/Library/Python/3.6/bin `` to your ``$PATH ``.
91
-
92
- .. _System Integrity Protection : https://support.apple.com/en-us/HT204899
93
- .. _Homebrew : https://brew.sh
76
+ .. _pip : https://pip.pypa.io/en/
77
+ .. _pip installation page : https://pip.pypa.io/en/stable/installation/
94
78
95
79
Installing on Windows
96
80
^^^^^^^^^^^^^^^^^^^^^
97
81
98
82
Installing beets on Windows can be tricky. Following these steps might help you
99
83
get it right:
100
84
101
- 1. If you don't have it, `install Python `_ (you want at least Python 3.8 ). The
85
+ 1. If you don't have it, `install Python `_ (you want at least Python 3.9 ). The
102
86
installer should give you the option to "add Python to PATH." Check this
103
87
box. If you do that, you can skip the next step.
104
88
@@ -109,7 +93,7 @@ get it right:
109
93
should open the "System Properties" screen, then select the "Advanced" tab,
110
94
then hit the "Environmental Variables..." button, and then look for the PATH
111
95
variable in the table. Add the following to the end of the variable's value:
112
- ``;C:\Python38 ;C:\Python38 \Scripts ``. You may need to adjust these paths to
96
+ ``;C:\Python39 ;C:\Python39 \Scripts ``. You may need to adjust these paths to
113
97
point to your Python installation.
114
98
115
99
3. Now install beets by running: ``pip install beets ``
@@ -123,9 +107,8 @@ sure the paths to Python match your system. Then double-click the file add the
123
107
necessary keys to your registry. You can then right-click a directory and
124
108
choose "Import with beets".
125
109
126
- Because I don't use Windows myself, I may have missed something. If you have
127
- trouble or you have more detail to contribute here, please direct it to
128
- `the mailing list `_.
110
+ If you have trouble or you have more detail to contribute here, please direct it to
111
+ `the discussion board `_.
129
112
130
113
.. _install Python : https://python.org/download/
131
114
.. _beets.reg : https://github.com/beetbox/beets/blob/master/extra/beets.reg
@@ -326,6 +309,5 @@ beets blog <https://beets.io/blog/walkthrough.html>`_.
326
309
Please let us know what you think of beets via `the discussion board `_ or
327
310
`Mastodon `_.
328
311
329
- .. _the mailing list : https://groups.google.com/group/beets-users
330
312
.. _the discussion board : https://github.com/beetbox/beets/discussions
331
313
.. _mastodon : https://fosstodon.org/@beets
0 commit comments