Difference between revisions of "User:LordSputnik/Warp"

From MusicBrainz Wiki
Line 1: Line 1:
 
Warp is an automatic audio file metadata tagger which uses the MusicBrainz Python library musicbrainzngs. Warp is free and open-source, and is released under the GPL license. Warp should work on any platform that runs Python 2.7. [[File:WarpIcon-Fade.png|180px|thumb|The Current Warp Icon... (Please make me a better one!)]]
 
Warp is an automatic audio file metadata tagger which uses the MusicBrainz Python library musicbrainzngs. Warp is free and open-source, and is released under the GPL license. Warp should work on any platform that runs Python 2.7. [[File:WarpIcon-Fade.png|180px|thumb|The Current Warp Icon... (Please make me a better one!)]]
  
==Key Features==
+
=Key Features=
 
*Able to automatically tag any MP3, Ogg Vorbis or FLAC file, that as already been tagged in Picard.
 
*Able to automatically tag any MP3, Ogg Vorbis or FLAC file, that as already been tagged in Picard.
 
*Able to run recursively on a set of directories - update your whole music library in one command!
 
*Able to run recursively on a set of directories - update your whole music library in one command!
Line 9: Line 9:
 
*Can ignore certain directories, if the user creates an empty "warp-ignore" file in the target directory.
 
*Can ignore certain directories, if the user creates an empty "warp-ignore" file in the target directory.
  
==Get it!==
+
=Get it!=
 
#Download the source distribution from https://github.com/LordSputnik/mb-masstagger.
 
#Download the source distribution from https://github.com/LordSputnik/mb-masstagger.
 
#Install Python, distutils, and pip.
 
#Install Python, distutils, and pip.
Line 16: Line 16:
 
#Run "python MassTagger.py"
 
#Run "python MassTagger.py"
  
==Manual==
+
=Manual=
===Installation (Dependencies)===
+
==Installation (Dependencies)==
 
The first thing to do is install the required dependencies, if you don't already have them. These dependencies are:
 
The first thing to do is install the required dependencies, if you don't already have them. These dependencies are:
 
* Python 2.7
 
* Python 2.7
Line 27: Line 27:
 
Hopefully in the future, Warp will have a nice installer that'll do all of this for you. But for now, it's a short manual process, varying depending on OS:
 
Hopefully in the future, Warp will have a nice installer that'll do all of this for you. But for now, it's a short manual process, varying depending on OS:
  
'''Windows'''
+
===Windows===
 
*To get Python, please visit http://www.python.org/
 
*To get Python, please visit http://www.python.org/
 
*Follow these instructions to get PIP: http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows
 
*Follow these instructions to get PIP: http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows
Line 33: Line 33:
 
*In the same command prompt, type "pip install mutagen"
 
*In the same command prompt, type "pip install mutagen"
  
'''Linux and Unix-based OSes'''
+
===Linux and Unix-based OSes===
 
*First of all, attempt to get everything from your Linux package manager.
 
*First of all, attempt to get everything from your Linux package manager.
 
**You'll probably be able to find python easily. On Ubuntu 12.10, you can get it by typing "sudo apt-get install python" in the terminal.
 
**You'll probably be able to find python easily. On Ubuntu 12.10, you can get it by typing "sudo apt-get install python" in the terminal.
Line 44: Line 44:
 
**Type "pip install mutagen"
 
**Type "pip install mutagen"
  
===Installation (Warp)===
+
==Installation (Warp)==
 
*First of all, visit https://github.com/LordSputnik/mb-masstagger and download the entire repository as a zip file.
 
*First of all, visit https://github.com/LordSputnik/mb-masstagger and download the entire repository as a zip file.
 
*Extract the zip file to your preferred location.
 
*Extract the zip file to your preferred location.
Line 51: Line 51:
 
*Open the command prompt or terminal in the directory you extracted the files to and type "python warp.py".
 
*Open the command prompt or terminal in the directory you extracted the files to and type "python warp.py".
  
===Editing the Options file===
+
==Editing the Options file==
 
The most important line in the options file is:
 
The most important line in the options file is:
  

Revision as of 13:13, 19 December 2012

Warp is an automatic audio file metadata tagger which uses the MusicBrainz Python library musicbrainzngs. Warp is free and open-source, and is released under the GPL license. Warp should work on any platform that runs Python 2.7.

The Current Warp Icon... (Please make me a better one!)

Key Features

  • Able to automatically tag any MP3, Ogg Vorbis or FLAC file, that as already been tagged in Picard.
  • Able to run recursively on a set of directories - update your whole music library in one command!
  • Configurable options file to allow for customization of the tagging process.
  • Can save either ID3v2.3 or v2.4 tags, and can remove APEv2 tags from MP3 files.
  • Can download cover art from the Cover Art Archive and add to all supported filetypes.
  • Can ignore certain directories, if the user creates an empty "warp-ignore" file in the target directory.

Get it!

  1. Download the source distribution from https://github.com/LordSputnik/mb-masstagger.
  2. Install Python, distutils, and pip.
  3. Using pip, install musicbrainzngs and mutagen.
  4. Copy the *.py files and options file into the directory you want to update.
  5. Run "python MassTagger.py"

Manual

Installation (Dependencies)

The first thing to do is install the required dependencies, if you don't already have them. These dependencies are:

  • Python 2.7
  • musicbrainzngs
  • mutagen

If you already have all of these, skip to Installation (Warp). Otherwise, read on.

Hopefully in the future, Warp will have a nice installer that'll do all of this for you. But for now, it's a short manual process, varying depending on OS:

Windows

Linux and Unix-based OSes

  • First of all, attempt to get everything from your Linux package manager.
    • You'll probably be able to find python easily. On Ubuntu 12.10, you can get it by typing "sudo apt-get install python" in the terminal.
    • On Ubuntu 12.10, musicbrainzngs is available by typing "sudo apt-get install python-musicbrainzngs"
    • On Ubuntu 12.10, mutagen is available as "sudo apt-get install python-mutagen"
  • If you can't find all of the packages in your package repository, follow some of these alternative instructions:

Installation (Warp)

  • First of all, visit https://github.com/LordSputnik/mb-masstagger and download the entire repository as a zip file.
  • Extract the zip file to your preferred location.
  • In the new folder, copy "options.default" and rename it to "options", with no extension.
  • Edit the file in Notepad or an equivalent text editor (see Editing the Options file).
  • Open the command prompt or terminal in the directory you extracted the files to and type "python warp.py".

Editing the Options file

The most important line in the options file is:

library_folder="xxx"

You must edit this line to the directory you want to update. The name can be relative to the folder containing warp.py, or an absolute file name (beginning with a drive letter on windows or / on linux).

For example, these are all acceptable:

  • library_folder="C:\Users\My_Username\Music\FLACs" (scans the absolute directory in Windows)
  • library_folder="/home/my_username/Music/FLACs" (scans the absolute directory in Linux)
  • library_folder="./" (scans the relative directory ./)
  • library_folder="temp" (scans the relative directory ./temp)