Welcome to MishMash

Contents:

MishMash

Music database and web interface.

Features

• MishMash is a music database using Python and SQLAlchemy.
• A command-line tool for building and managing a music database.
• Web browser interface (using Pyramid) for browsing your music library.
• Uses eyeD3 for reading MP3s and ID3 metadata.
• Support and tested with Python 3.6 and Postgresql. SQLite is periodically tested with, but future features may not be supported (e.g. full text search).
• Free software: GNU GPL v3.0 license

Getting Started

$ mishmash info
/\/\_____  .__       .__        _____                .__   /\/\
\(\(     \ |__| _____|  |__    /     \ _____    _____|  |__\(\(
  /  \ /  \|  |/  ___/  |  \  /  \ /  \\__  \  /  ___/  |  \
 /    Y    \  |\___ \|   Y  \/    Y    \/ __ \_\___ \|   Y  \
 \____|__  /__/____  >___|  /\____|__  (____  /____  >___|  /
         \/        \/     \/         \/     \/     \/     \/

Version              : 0.3
Database URL         : sqlite:////~/mishmash.db
Database version     : 0.3
Last sync            : Never
Configuration files  : <default>


=== Music library ===
0 music tracks
0 music artists
0 music albums
0 music tags

Surprise, you now have an empty sqlite database in your home directory. Let’s leave it here for now, it can be located elsewhere or use a different database using command line arguments and/or environment variables. Pretty useless, so now add some music.:

$ mishmash sync ~/Music/Melvins
Syncing library 'Music': paths=['~/Music/Melvins/']
Syncing directory: ~/Music/Melvins/
Syncing directory: ~/Music/Melvins/1984 - Mangled Demos
Adding artist: Melvins
Syncing directory: ~/Music/Melvins/1986 - 10 Songs
Adding album: 10 Songs
Adding track: ~/Music/Melvins/1986 - 10 Songs/Melvins - 01 - Easy As It Was.mp3
Updating album: 10 Songs
...
== Library 'Music' sync'd [ 8.73s time (45.9 files/s) ] ==
401 files sync'd
401 tracks added
0 tracks modified
0 orphaned tracks deleted
0 orphaned artists deleted
0 orphaned albums deleted

Use your database as you wish. Browse it with mishmash web, or use one of its management commands.

Check out the Unsonic project for streaming capabilities.

Installation

Using pip

At the command line:

$ pip install mishmash
$ pip install mishmash[postgres]
$ pip install mishmash[web]

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv MishMash
$ pip install mishmash

Using a source distribution

At the command line:

$ tar zxf mishmash-0.3b9.tar.gz
$ cd mishmash-0.3b9
$ python setup.py install

From GitHub

At the command line:

$ git clone https://github.com/nicfit/MishMash
$ cd mishmash
$ python setup.py install

Additional dependencies should be installed if developing MishMash:

$ pip install -r requirements/dev.txt

Dependencies

All the required software dependencies are installed using either requirements/default.txt files or by python install setup.py.

Usage

Configuration

MishMash ships with a default configuration that should work out of the box with no extra additional settings by using a SQLite database saved in ${HOME}/mishmash.db. Running mishmash info with demonstrate this, afterwards mishmash.db will exist in your home directory and be initialized with the database schema.

$ mishmash info
$ sqlite3 /home/travis/mishmash.db
sqlite> select * from artists;
1|Various Artists|Various Artists|2014-10-11 01:12:10.246406|||
sqlite>

To see the current configuration use info command’s --default-config option. You may wish to capture this output for writing custom configuration files.

$ mishmash --default-config
[mishmash]
sqlalchemy.url = sqlite:////home/travis/mishmash.db

[loggers]
keys = root, sqlalchemy, eyed3, mishmash

[handlers]
keys = console

[formatters]
keys = generic

[logger_root]
level = INFO
handlers = console

... more config ...

The first change most users will want to do is change the database that MishMash uses. The -D/--database option make this easy. In this example, information about ./mymusic.db SQLite database and the mymusic PostgreSQL database is displayed.

$ mishmash --database=sqlite:///mymusic.db info
$ mishmash -D postgresql://mishmash@localhost:5432/mymusic info

In you wish to make additional configuration changes, or would like to avoid needing to type the database URL all the time, a configuration is needed. The file may contain the entire configuration or only the values you wish to change (i.e. changes are applied to the default configuration). With the settings saved to a file use the -c/--config option to have MishMash use it. In this examples the database URL and a logging level are modified.

$ cat example.ini
[mishmash]
sqlalchemy.url = postgresql://mishmash@localhost:5432/mymusic

[logger_sqlalchemy]
level = DEBUG

$ mishmash -c example.ini info

You can avoid typing -c/--config option by setting the file name in the MISHMASH_CONFIG environment variable.

$ export MISHMASH_CONFIG=/etc/mishmash.ini

None of the options for controlling configuration are mutually exclusive, complex setups can be made by combining them. The order of precedence is show below:

Default <-- -c/--config <-- MISHMASH_CONFIG <-- -D/--database

Items to the left are lower precedence and the direction arrows (<--) show the order in which the options are merged. For example, local machine changes (local.ini) could be merged with the global site configuration (site.ini) and the PostgreSQL server at dbserver.example.com is used regardless then the other files set.

$ MISHMASH_CONFIG=local.ini mishmash -c site.ini -D postgresql://dbserver.example.com:5432/music

Databases

The first requirement is deciding a database for MishMash to use. One of the great things about SQLAlchemy is its support for a multitude of databases, feel free to try whichever you would like but that the only back-ends that are currently tested/supported are:

* Postgresql
* SQLite; limited testing.

The default value uses a SQLite database called ‘mishmash.db’ in the user’s home directory.:

sqlite:///${HOME}/mishmash.db

The URL in this example specifies the type of database (i.e. SQLite) and the filename of the DB file. The following sections provide more URL examples for Postgresql (where authentication credentials are required) and SQLite but see the full documentation for SQLAlchemy database URLs for a complete reference.

Postgresql

The pattern for Postgresql URLs is:

postgresql://user:passwd@host:port/db_name

user and passwd are the login credentials for accessing the database, while host and port (the default is 5432) determine where to connect. Lastly, the specific name of the database that contains the MishMash data is given by db_name. A specific example:

postgresql://mishmash:mishmash@localhost/mishmash_test

Setup of initial database and roles::

$ createuser --createdb mishmash
$ createdb -E utf8 -U mishmash mishmash

SQLite

The pattern for SQLite URLs is:

sqlite://filename

The slashes can be a little odd, so some examples:

sqlite:///relative/path/to/filename.db
sqlite:////absolute/path/to/filename.db
sqlite:///:memory:

The last example specifies an in-memory database that only exists as long as the application using it.

mishmash info

The info command displays details about the current settings and database. TODO

mishmash sync

The sync command imports music metadata into the database. TODO

mishmash web

The web command runs the web interface. TODO

mishmash merge-artists

TODO

mishmash split-artists

Since MishMash tries not to make assumption about directory structure there may be times when multiple artists with the same name are merged. The split-artists command can use to fix this.:

$ mishmash split-artists -L Music "The Giraffes"

The city of origin is used to distinguish between each of the artists and then albums are assigned to each.:

4 albums by The Giraffes:
   2005       The Giraffes
   2005       Haunted Heaven EP
   2008       Prime Motivator
   2000       The Days Are Filled With Years

Enter the number of distinct artists: 2

The Giraffes #1
   City: Brooklyn
   State: NY
   Country: US

The Giraffes #2
   City: Seattle
   State: WA
   Country: USA

Assign albums to the correct artist.
Enter 1 for The Giraffes from Brooklyn, NY, USA
Enter 2 for The Giraffes from Seattle, WA, USA

The Giraffes (Giraffes, The (Brooklyn)/2005 - The Giraffes): 1
Haunted Heaven EP (Giraffes, The (Brooklyn)/2005 - Haunted Heaven EP): 1
Prime Motivator (Giraffes, The (Brooklyn)/2008 - Prime Motivator): 1
The Days Are Filled With Years (Giraffes, The (Seattle)/2000 - The Days Are Filled With Years): 2

mishmash

mishmash package

Subpackages

mishmash.commands package

Submodules

mishmash.commands.command module

mishmash.commands.info module

class mishmash.commands.info.DisplayList

Bases: object

add(key, val)

clear()

print(_format, clear=False, **kwargs)

class mishmash.commands.info.Info(subparsers=None, **kwargs)

Bases: mishmash.core.Command

Construct a command. Any kwargs are added to the class object using setattr. All commands have an ArgumentParser, either constructed here or when subparsers is given a new parser is created using its add_parser method.

HELP = 'Show information about the database and configuration.'

NAME = 'info'

lib_query(OrgType, lib)

mishmash.commands.mgmt module

class mishmash.commands.mgmt.MergeArtists(subparsers=None, **kwargs)

Bases: mishmash.core.Command

Construct a command. Any kwargs are added to the class object using setattr. All commands have an ArgumentParser, either constructed here or when subparsers is given a new parser is created using its add_parser method.

HELP = 'Merge two or more artists into a single artist.'

NAME = 'merge-artists'

class mishmash.commands.mgmt.SplitArtists(subparsers=None, **kwargs)

Bases: mishmash.core.Command

Construct a command. Any kwargs are added to the class object using setattr. All commands have an ArgumentParser, either constructed here or when subparsers is given a new parser is created using its add_parser method.

HELP = 'Split a single artist name into N distinct artists.'

NAME = 'split-artists'

mishmash.commands.sync module

mishmash.commands.web module

class mishmash.commands.web.Web(subparsers=None, **kwargs)

Bases: mishmash.core.Command

Construct a command. Any kwargs are added to the class object using setattr. All commands have an ArgumentParser, either constructed here or when subparsers is given a new parser is created using its add_parser method.

HELP = 'MishMash web interface.'

NAME = 'web'

Module contents

mishmash.web package

Submodules

mishmash.web.layouts module

class mishmash.web.layouts.AppLayout(context, request)

Bases: object

add_heading(name, *args, **kw)

page_title

mishmash.web.models module

mishmash.web.models.DBSession = None

The type for making sessions.

mishmash.web.panels module

mishmash.web.panels.album_cover(context, request, album, size=None, link=False)

mishmash.web.panels.footer(context, request)

mishmash.web.panels.navbar(context, request)

mishmash.web.views module

class mishmash.web.views.ResponseDict(*args, **kwargs)

Bases: dict

mishmash.web.views.albumView(request)

mishmash.web.views.allAlbumsView(request)

mishmash.web.views.allArtistsView(request)

mishmash.web.views.artistView(request)

mishmash.web.views.covers(request)

mishmash.web.views.home_view(request)

mishmash.web.views.newMusicView(request)

mishmash.web.views.searchView(request)

Module contents

mishmash.web.main(global_config, **main_settings)

Submodules

mishmash.config module

class mishmash.config.Config(filename, **kwargs)

Bases: nicfit.config.Config

db_url

music_libs

class mishmash.config.MusicLibrary(name, paths=None, excludes=None, sync=True)

Bases: object

static fromConfig(config)

mishmash.console module

mishmash.console.promptArtist(text, name=None, default_name=None, default_city=None, default_state=None, default_country=None, artist=None)

mishmash.console.selectArtist(heading, choices=None, multiselect=False, allow_create=True)

mishmash.core module

class mishmash.core.Command(subparsers=None, **kwargs)

Bases: nicfit.command.Command

Base class for MishMash commands.

Construct a command. Any kwargs are added to the class object using setattr. All commands have an ArgumentParser, either constructed here or when subparsers is given a new parser is created using its add_parser method.

run(args, config)

exception mishmash.core.CommandError(msg, exit_status=1)

Bases: Exception

Base error type for nicfit.command.Command errors.

mishmash.database module

class mishmash.database.DatabaseInfo(engine, SessionMaker, connection)

Bases: tuple

Create new instance of DatabaseInfo(engine, SessionMaker, connection)

SessionMaker

Alias for field number 1

connection

Alias for field number 2

engine

Alias for field number 0

mishmash.database.dropAll(url)

mishmash.database.getTag(t, session, lid, add=False)

mishmash.database.init(db_url, engine_args=None, session_args=None, trans_mgr=None, scoped=False)

mishmash.database.search(session, query)

mishmash.orm module

Object to relational database mappings for all tables.

class mishmash.orm.Album(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base, mishmash.orm.OrmObject

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

DATE_LIMIT = 24

TITLE_LIMIT = 256

artist

artist_id

date_added

duration

getBestDate()

id

images

one-to-many album images.

lib_id

library

original_release_date

recording_date

release_date

tags

title

tracks

type

class mishmash.orm.AlbumDate(*args, **kwargs)

Bases: sqlalchemy.sql.type_api.TypeDecorator

Custom column type for eyed3.core.Date objects. That is, dates than can have empty rather than default date fields. For example, 1994 with no month and day is different than 1994-01-01, as datetime provides.

Construct a TypeDecorator.

Arguments sent here are passed to the constructor of the class assigned to the impl class level attribute, assuming the impl is a callable, and the resulting object is assigned to the self.impl instance attribute (thus overriding the class attribute of the same name).

If the class level impl is not a callable (the unusual case), it will be assigned to the same instance attribute ‘as-is’, ignoring those arguments passed to the constructor.

Subclasses can override this to customize the generation of self.impl entirely.

impl = String(length=24)

process_bind_param(value, dialect)

Receive a bound parameter value to be converted.

Subclasses override this method to return the value that should be passed along to the underlying TypeEngine object, and from there to the DBAPI execute() method.

The operation could be anything desired to perform custom behavior, such as transforming or serializing data. This could also be used as a hook for validating logic.

This operation should be designed with the reverse operation in mind, which would be the process_result_value method of this class.

Parameters:

• value – Data to operate upon, of any type expected by this method in the subclass. Can be None.
• dialect – the Dialect in use.

process_result_value(value, dialect)

Receive a result-row column value to be converted.

Subclasses should implement this method to operate on data fetched from the database.

Subclasses override this method to return the value that should be passed back to the application, given a value that is already processed by the underlying TypeEngine object, originally from the DBAPI cursor method fetchone() or similar.

The operation could be anything desired to perform custom behavior, such as transforming or serializing data. This could also be used as a hook for validating logic.

Parameters:

• value – Data to operate upon, of any type expected by this method in the subclass. Can be None.
• dialect – the Dialect in use.

This operation should be designed to be reversible by the “process_bind_param” method of this class.

class mishmash.orm.Artist(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base, mishmash.orm.OrmObject

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

CITY_LIMIT = 64

COUNTRY_LIMIT = 3

NAME_LIMIT = 256

SORT_NAME_LIMIT = 258

STATE_LIMIT = 32

albums

all albums by the artist

static checkUnique(artists)

date_added

getAlbumsByType(album_type)

getTrackSingles()

id

images

one-to-many artist images.

is_various_artist

lib_id

library

name

origin(n=3, country_code='country_name', title_case=True)

origin_city

origin_country

origin_state

sort_name

tags

one-to-many (artist->tag) and many-to-one (tag->artist)

tracks

all tracks by the artist

url_name

class mishmash.orm.Image(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base, mishmash.orm.OrmObject

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

ARTIST_TYPE = 'ARTIST'

BACK_COVER_TYPE = 'BACK_COVER'

DESC_LIMIT = 1024

FRONT_COVER_TYPE = 'FRONT_COVER'

IMAGE_TYPES = ['FRONT_COVER', 'BACK_COVER', 'MISC_COVER', 'LOGO', 'ARTIST', 'LIVE']

LIVE_TYPE = 'LIVE'

LOGO_TYPE = 'LOGO'

MD5_LIMIT = 32

MIMETYPE_LIMIT = 32

MISC_COVER_TYPE = 'MISC_COVER'

data

description

The description will be the base file name when the source if a file.

static fromFile(path, type_)

static fromTagFrame(img, type_)

id

md5

mime_type

size

type

class mishmash.orm.Library(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base, mishmash.orm.OrmObject

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

NAME_LIMIT = 64

add(album)

albums()

id

classmethod iterall(session, names=None)

Iterate over all Library rows found in session. :param names: Optional sequence of names to filter on.

last_sync

name

class mishmash.orm.Meta(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base, mishmash.orm.OrmObject

Table meta used for storing database schema version, timestamps, and any other metadata about the music collection.

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

VERSION_LIMIT = 32

last_sync

A UTC timestamp of the last sync operation.

version

The MishMash version defines the database schema.

class mishmash.orm.OrmObject

Bases: object

Base classes for all other mishmash.orm classes.

mishmash.orm.TABLES = [Table('meta', MetaData(bind=None), Column('version', String(length=32), table=<meta>, primary_key=True, nullable=False), Column('last_sync', DateTime(), table=<meta>), schema=None), Table('libraries', MetaData(bind=None), Column('id', Integer(), table=<libraries>, primary_key=True, nullable=False, default=Sequence('libraries_id_seq', metadata=MetaData(bind=None))), Column('name', Unicode(length=64), table=<libraries>, nullable=False), Column('last_sync', DateTime(), table=<libraries>), schema=None), Table('tags', MetaData(bind=None), Column('id', Integer(), table=<tags>, primary_key=True, nullable=False, default=Sequence('tags_id_seq', metadata=MetaData(bind=None))), Column('name', Unicode(length=64), table=<tags>, nullable=False), Column('lib_id', Integer(), ForeignKey('libraries.id'), table=<tags>, nullable=False), schema=None), Table('artists', MetaData(bind=None), Column('id', Integer(), table=<artists>, primary_key=True, nullable=False, default=Sequence('artists_id_seq', metadata=MetaData(bind=None))), Column('name', Unicode(length=256), table=<artists>, nullable=False), Column('sort_name', Unicode(length=258), table=<artists>, nullable=False), Column('date_added', DateTime(), table=<artists>, nullable=False, default=ColumnDefault(<function datetime.now>)), Column('origin_city', Unicode(length=64), table=<artists>), Column('origin_state', Unicode(length=32), table=<artists>), Column('origin_country', String(length=3), table=<artists>), Column('lib_id', Integer(), ForeignKey('libraries.id'), table=<artists>, nullable=False), schema=None), Table('albums', MetaData(bind=None), Column('id', Integer(), table=<albums>, primary_key=True, nullable=False, default=Sequence('albums_id_seq', metadata=MetaData(bind=None))), Column('title', Unicode(length=256), table=<albums>, nullable=False), Column('type', Enum('lp', 'ep', 'compilation', 'live', 'various', 'demo', 'single', name='album_types'), table=<albums>, nullable=False, default=ColumnDefault('lp')), Column('date_added', DateTime(), table=<albums>, nullable=False, default=ColumnDefault(<function datetime.now>)), Column('release_date', AlbumDate(length=24), table=<albums>), Column('original_release_date', AlbumDate(length=24), table=<albums>), Column('recording_date', AlbumDate(length=24), table=<albums>), Column('artist_id', Integer(), ForeignKey('artists.id'), table=<albums>, nullable=False), Column('lib_id', Integer(), ForeignKey('libraries.id'), table=<albums>, nullable=False), schema=None), Table('tracks', MetaData(bind=None), Column('id', Integer(), table=<tracks>, primary_key=True, nullable=False, default=Sequence('tracks_id_seq', metadata=MetaData(bind=None))), Column('path', String(length=2048), table=<tracks>, nullable=False), Column('size_bytes', Integer(), table=<tracks>, nullable=False), Column('ctime', DateTime(), table=<tracks>, nullable=False), Column('mtime', DateTime(), table=<tracks>, nullable=False), Column('date_added', DateTime(), table=<tracks>, nullable=False, default=ColumnDefault(<function datetime.now>)), Column('time_secs', Float(), table=<tracks>, nullable=False), Column('title', Unicode(length=256), table=<tracks>, nullable=False), Column('track_num', SmallInteger(), table=<tracks>), Column('track_total', SmallInteger(), table=<tracks>), Column('media_num', SmallInteger(), table=<tracks>), Column('media_total', SmallInteger(), table=<tracks>), Column('bit_rate', SmallInteger(), table=<tracks>), Column('variable_bit_rate', Boolean(), table=<tracks>), Column('metadata_format', Enum('ID3v1.0', 'ID3v1.1', 'ID3v2.2', 'ID3v2.3', 'ID3v2.4', name='metadata_format'), table=<tracks>, nullable=False), Column('artist_id', Integer(), ForeignKey('artists.id'), table=<tracks>, nullable=False), Column('album_id', Integer(), ForeignKey('albums.id'), table=<tracks>), Column('lib_id', Integer(), ForeignKey('libraries.id'), table=<tracks>, nullable=False), schema=None), Table('images', MetaData(bind=None), Column('id', Integer(), table=<images>, primary_key=True, nullable=False, default=Sequence('images_id_seq', metadata=MetaData(bind=None))), Column('type', Enum('FRONT_COVER', 'BACK_COVER', 'MISC_COVER', 'LOGO', 'ARTIST', 'LIVE', name='image_types'), table=<images>, nullable=False), Column('mime_type', String(length=32), table=<images>, nullable=False), Column('md5', String(length=32), table=<images>, nullable=False), Column('size', Integer(), table=<images>, nullable=False), Column('description', String(length=1024), table=<images>, nullable=False), Column('data', LargeBinary(), table=<images>, nullable=False), schema=None), Table('artist_tags', MetaData(bind=None), Column('artist_id', Integer(), ForeignKey('artists.id'), table=<artist_tags>), Column('tag_id', Integer(), ForeignKey('tags.id'), table=<artist_tags>), schema=None), Table('album_tags', MetaData(bind=None), Column('album_id', Integer(), ForeignKey('albums.id'), table=<album_tags>), Column('tag_id', Integer(), ForeignKey('tags.id'), table=<album_tags>), schema=None), Table('track_tags', MetaData(bind=None), Column('track_id', Integer(), ForeignKey('tracks.id'), table=<track_tags>), Column('tag_id', Integer(), ForeignKey('tags.id'), table=<track_tags>), schema=None), Table('artist_images', MetaData(bind=None), Column('artist_id', Integer(), ForeignKey('artists.id'), table=<artist_images>), Column('img_id', Integer(), ForeignKey('images.id'), table=<artist_images>), schema=None), Table('album_images', MetaData(bind=None), Column('album_id', Integer(), ForeignKey('albums.id'), table=<album_images>), Column('img_id', Integer(), ForeignKey('images.id'), table=<album_images>), schema=None)]

All the table instances. Order matters (esp. for postgresql). The tables are created in normal order, and dropped in reverse order.

class mishmash.orm.Tag(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base, mishmash.orm.OrmObject

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

NAME_LIMIT = 64

id

lib_id

library

name

class mishmash.orm.Track(**kwargs)

Bases: sqlalchemy.ext.declarative.api.Base, mishmash.orm.OrmObject

Along with the column args a audio_file keyword may be passed for this class to use for initialization.

METADATA_FORMATS = ['ID3v1.0', 'ID3v1.1', 'ID3v2.2', 'ID3v2.3', 'ID3v2.4']

PATH_LIMIT = 2048

TITLE_LIMIT = 256

album

album_id

artist

artist_id

bit_rate

ctime

date_added

id

lib_id

library

media_num

media_total

metadata_format

mtime

path

size_bytes

tags

time_secs

title

track_num

track_total

update(audio_file)

variable_bit_rate

mishmash.orm.album_images = Table('album_images', MetaData(bind=None), Column('album_id', Integer(), ForeignKey('albums.id'), table=<album_images>), Column('img_id', Integer(), ForeignKey('images.id'), table=<album_images>), schema=None)

Pivot table ‘album_images’ for mapping an album ID to a value in the images table.

mishmash.orm.album_tags = Table('album_tags', MetaData(bind=None), Column('album_id', Integer(), ForeignKey('albums.id'), table=<album_tags>), Column('tag_id', Integer(), ForeignKey('tags.id'), table=<album_tags>), schema=None)

Pivot table ‘album_tags’ for mapping an album ID to a value in the tags table.

mishmash.orm.artist_images = Table('artist_images', MetaData(bind=None), Column('artist_id', Integer(), ForeignKey('artists.id'), table=<artist_images>), Column('img_id', Integer(), ForeignKey('images.id'), table=<artist_images>), schema=None)

Pivot table ‘artist_images’ for mapping an artist ID to a value in the images table.

mishmash.orm.artist_tags = Table('artist_tags', MetaData(bind=None), Column('artist_id', Integer(), ForeignKey('artists.id'), table=<artist_tags>), Column('tag_id', Integer(), ForeignKey('tags.id'), table=<artist_tags>), schema=None)

Pivot table ‘artist_tags’ for mapping an artist ID to a value in the tags table.

mishmash.orm.getSortName(name)

mishmash.orm.set_sqlite_pragma(dbapi_connection, connection_record)

Allows foreign keys to work in sqlite.

mishmash.orm.track_tags = Table('track_tags', MetaData(bind=None), Column('track_id', Integer(), ForeignKey('tracks.id'), table=<track_tags>), Column('tag_id', Integer(), ForeignKey('tags.id'), table=<track_tags>), schema=None)

Pivot table ‘track_tags’ for mapping a track ID to a value in the tags table.

mishmash.util module

mishmash.util.commonDirectoryPrefix(*args)

mishmash.util.mostCommonItem(lst)

Choose the most common item from the list, or the first item if all items are unique.

mishmash.util.normalizeCountry(country_str, target='iso3c', title_case=False)

Return a normalized name/code for country in country_str. The input can be a code or name, the target determines output value. 3 character ISO code is the default (iso3c), ‘country_name’, and ‘iso2c’ are common also. See countrycode.countrycode for details and other options. Raises ValueError if the country is unrecognized.

mishmash.util.safeDbUrl(db_url)

Obfuscates password from a database URL.

mishmash.util.sortByDate(things, prefer_recording_date=False)

mishmash.util.splitNameByPrefix(s)

Module contents

mishmash.getLogger(name=None)

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/nicfit/MishMash/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation

MishMash could always use more documentation, whether as part of the official MishMash docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/nicfit/MishMash/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up MishMash for local development.

1. Fork the MishMash repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/MishMash.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv mishmash
   $ cd mishmash/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

$ make lint
$ make test
$ make test-all    # Optional, requires multiple versions of Python

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub.:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7, and 3.3, 3.4, 3.5, and for PyPy. Check https://travis-ci.org/nicfit/MishMash/pulls and make sure that the tests pass for all supported Python versions.

Authors

• Travis Shirk <travis@pobox.com>
• nicfit <nicfit@gmail.com>
• Chris Newton <redshodan@users.noreply.github.com>
• pyup-bot <github-bot@pyup.io>
• me@benschumacher.com

Release History

v0.3b9 (2018-12-02)

New

• Split-artist docs.
• mishmash web albums view.
• mishmash web artist filters.

Fix

• Database URL obfuscation is more reliable.

v0.3b8 (2018-11-28)

New

• Added MishMash(ConfigClass=clazz) keyword argument.

v0.3b7 (2018-06-18)

New

• More multi-lib supoort (merge, split, info)

Fix

• Return resolved album when a sync does not occur.
• Recent inotify uses Unicode natively, remove conversions to bytes.
• Pick up new image files when rescanning and no audio files changed.

Other

• Run make test targets thru tox. Travis-CI will do this in a future commit.

v0.3b6 (2018-02-18)

New

• Mishmash info -L/–library and –artists.

Changes

• Reduced sync stats precision.
• Nicfit.py 0.8 Command changes.

Fix

• Fix container fail to start issue (#242) <me@benschumacher.com>
• Added check for osx to avoid monitor mode (#260) <redshodan@gmail.com>
• Nicfit.py 0.8 config_env_var changes.
• Removed no-arg (nicfit.py) main test, test is done upstream.

v0.3b5 (2017-11-26) : I Need a Miracle

New

• Mishmash_cmd session-scoped fixture.
• Library ‘excludes’ option. Fixes #202.
• orm length limit constants
• More ORM limit tests, truncation, validation.
• Use mishmash.util.safeDbUrl for displayed/logged password obfuscation.
• Add Track.metadata_format and Track.METADATA_FORMATS.

Changes

• Moved VARIOUS_TYPE detection info _albumTypeHint. less noise about lp->various conversion
• Close DB connections after commands.
• Better logging for debugging VARIOUS_TYPE coersion.
• Moved limit constants to each ORM class.
• Docker updates.

Fix

• PServeCommand requires .ini extension.
• Show used config files.
• Some (not all) truncation for colomn limits and x00 handling.
• Make docker-publish.
• Dup config section error.

v0.3b4 (2017-05-14) : Triumph Of Death

New

• Init(scope=False), for wrapped SessionMaker with sqlalchemy.orm.scoped_session.
• Mishmash.web is optional, and packaged as extra [web] install.
• Mishmash.VARIOUS_ARTISTS_NAME == gettext(“Various Artists”)

Changes

• Removed various artist config and started gettext.

Fix

• Mishmash.web working again.

Other

• Update eyed3 from 0.8.0b1 to 0.8 (#108) <github-bot@pyup.io>
• Pin pyramid to latest version 1.8.3 (#94) <github-bot@pyup.io>

v0.3b3 (2017-04-09) : Prayers for Rain

New

• UTC sync times and per lib last_sync. Fixes #6, #7.
• Db test fixtures, etc.

Changes

• mishmash.data.init now returns the 3-tuple (engine, SessionMaker, connection). Previously a 2-tuple, sans connection, was returned. The new mishmash.database.DatebaseInfo namedtuple is the actual return type, if you prefer not to unpack the return value.

v0.3b2 (2017-03-12) : Nine Patriotic Hymns For Children

Fix

• Protect against not being the first to call multiprocessing.set_start_method.

v0.3b1 (2017-03-12) : Nine Patriotic Hymns For Children

New

• Mismash sync –monitor (using inotify)
• Test beginnings.

Changes

• Label_id renamed tag_id. Fixes #65.
• Mishmash.database.init accepts the DB URL as its first arguments, NO LONGER a Config object.

Fix

• Postgres service on Travis-CI.
• Restored gitchangelog fork.

v0.3b0 (2017-02-26)

• Initial release

Indices and tables

• Index
• Module Index
• Search Page