May 25, 2015 · pluuft api Documentation, Release stable Dinosaurs will slowly die. Contents 1

pluuft api DocumentationRelease stable

May 25, 2015

Contents

1 License 3

2 What is Shiva? 5

3 Prerequisites 7

4 Installation 9

5 Installation using pip 115.1 Configuring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

6 Indexing 136.1 Restricting extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136.2 Scanning directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

7 Clients 157.1 Wish you were here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

8 Resources 178.1 Artists Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178.2 Shows Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188.3 Albums Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198.4 Track Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208.5 Lyrics Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238.6 The fulltree modifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248.7 Pagination . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268.8 Using slugs instead of IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268.9 Uniqueness of slugs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278.10 Random resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

9 Format conversion 299.1 Absolute paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299.2 Your converter sucks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309.3 The MimeType class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

10 What’s new? 33

11 Cross Origin Resource Sharing 35

i

12 Want to contribute? 3712.1 Sending code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

13 Bug Reports 39

14 Assumptions 41

15 Wish list 43

16 Disclaimer 45

17 Why Shiva? 47

ii

pluuft api Documentation, Release stable

Dinosaurs will slowly die.

Contents 1


2 Contents

CHAPTER 1

License

Please read the LICENSE file distributed with this software.

3


4 Chapter 1. License

CHAPTER 2

What is Shiva?

The Mozilla Hacks blog kindly published a nice article that explains the ideas that inspire this software: Shiva: Morethan a RESTful API to your music collection

5

https://hacks.mozilla.org/2013/03/shiva-more-than-a-restful-api-to-your-music-collection/

https://hacks.mozilla.org/2013/03/shiva-more-than-a-restful-api-to-your-music-collection/


6 Chapter 2. What is Shiva?

CHAPTER 3

Prerequisites

You are going to need:

• ffmpeg

• libxml C headers

• python headers

• sqlite (optional)

If you want Shiva to automatically fetch artists’ images from Last.FM while indexing you are going to need an APIkey. You can get one at http://www.last.fm/api/account/create

This makes the whole indexing slower because issues a request on a per-album and per-artist basis, but does a lot ofwork automatically for you.

By default Shiva uses a SQLite database, but this can be overriden.

To install all the dependencies on Debian (and derivatives):

sudo apt-get install libxml2-dev libxslt-dev ffmpeg python-dev sqlite

If at some point of the installation process you get the error:

/usr/bin/ld: cannot find -lz

You also need the package lib32z1-dev

On Mac OS X with homebrew you can get the libxml headers with:

brew install libxml2 libxslt

On Mac OS X sqlite should come pre-installed. If it’s not:

brew install sqlite

7

http://www.last.fm/api/account/create

http://mxcl.github.com/homebrew/


8 Chapter 3. Prerequisites

CHAPTER 4

Installation

• Get the source:

$ git clone https://github.com/tooxie/shiva-server.git$ cd shiva-server

• Create and activate your virtalenv (highly recommended):

$ virtualenv .virtualenv$ source .virtualenv/bin/activate

• Install:

$ python setup.py develop

• Rename shiva/config/local.py.example to local.py:

$ cp shiva/config/local.py.example shiva/config/local.py

See Configuring for more info.

• Edit it and configure the directories to scan for music.

– See Scanning directories for more info.

• Run the indexer:

$ shiva-indexer

• Run the file server:

$ shiva-fileserver

• Run the server in a different console:

$ shiva-server

• Point your browser to a Resource, like: http://127.0.0.1:9002/artists (See Resources)

9

http://127.0.0.1:9002/artists


10 Chapter 4. Installation

CHAPTER 5

Installation using pip

You can install Shiva through pip, running the following command:

$ pip install shiva

That will automatically download and install Shiva and all its dependencies.

Note: This will install the latest release, which may contain bugs and lack some features. It is highly recommendedthat you install the latest development version, following the manual installation guide above.

5.1 Configuring

Shiva looks for config files in the following places:

• config/local.py relative to the directory where Shiva is installed.

• If an environment variable $SHIVA_CONFIG is set, then is assumed to be pointing to a config file.

• $XDG_CONFIG_HOME/shiva/config.py which defauls to $HOME/.config/shiva/config.py.

If all 3 files exist, then all 3 will be read and overriden in that same order, so$XDG_CONFIG_HOME/shiva/config.py will take precedence over config/local.py.

5.1.1 DEBUG

It’s possible to load settings specific for debugging. If you have the following in any of your config files:

DEBUG = True

Then Shiva will also try to load this configuration files:

• config/debug.py relative to the directory where Shiva is installed.

• $XDG_CONFIG_HOME/shiva/debug.py which defauls to $HOME/.config/shiva/debug.py.

In this case $XDG_CONFIG_HOME/shiva/debug.py will also have precedence over config/debug.py.

11


12 Chapter 5. Installation using pip

CHAPTER 6

Indexing

The indexer receives the following command line arguments.

• --lastfm

• --hash

• --nometadata

• --reindex

• --write-every=<num>

If you set the --lastfm flag Shiva will retrieve artist and album images from Last.FM, but for this to work you needto get an API key (see Prerequisites) and include it in your local.py config file.

When --hash is present, Shiva will hash every file using the md5 algorithm, in order to find duplicates, which willbe ignored. Note that this will decrease indexing speed notably.

The --nometadata option saves dummy tracks with only path information, ignoring the file’s metadata. This meansthat albums and artists will not be saved, but indexing will be as fast as it gets.

If both the --nometadata and --lastfm flags are set, --nometadata will take precedence and --lastfmwill be ignored.

With --reindex the whole database will be dropped and recreated. Be careful, all existing information will bedeleted. If you just want to update your music collection, run the indexer again without the --reindex option.

The indexer is optimized for performance; hard drive hits, like file reading or DB queries, are done as few as possible.As a consequence, memory usage is quite heavy. Keep that in mind when indexing large collections.

To keep memory usage down, you can use the --write-every parameter. It receives a number and will write downto disk and clear cache after that many tracks indexed. If you pass 1, it will completely ignore cache and just writeevery track to disk. This has the lowest possible memory usage, but as a downside, indexing will be much slower.

It’s up to you to find a good balance between the size of your music collection and the available RAM that you have.

6.1 Restricting extensions

If you want to limit the extensions of the files to index, just add the following config to your local.py file:

ALLOWED_FILE_EXTENSIONS = ('mp3', 'ogg')

That way only ‘mp3’ and ‘ogg’ files will be indexed.

13


6.2 Scanning directories

To tell Shiva which directories to scan for music, you will have to configure your shiva/config/local.py file.There you will find a MEDIA_DIRS option where you need to supply MediaDir objects.

This object allows for media configuration. By instantiating a MediaDir class you can tell Shiva where to look forthe media files and how to serve those files. It’s possible to configure the system to look for files on a directory andserve those files through a different server.

MediaDir(root='/srv/http', dirs=('/music', '/songs'),url='http://localhost:8080/')

Given that configuration Shiva will scan the directories /srv/http/music and /srv/http/songsfor media files, but they will be served through http://localhost:8080/music/ andhttp://localhost:8080/songs/.

If just a dir is provided you will also need to run the file server, as mentioned in the installation guide. This is a simplefile server, for testing purposes only. Do NOT use in a live environment.

MediaDir('/home/fatmike/music')

For more information, check the source of shiva/media.py.

14 Chapter 6. Indexing

CHAPTER 7

Clients

• Shiva-Client

A web-based front-end built as a single page application using HTML5 technologies. It includes its own test webserver so you don’t need to install one.

• Shiva4J

Java implementation of the Shiva protocol. Runs on android.

• Shakti

A web based client built with AngularJS.

7.1 Wish you were here

Or you can also build your own client and put your own ideas into practice. I encourage you to do so. Build your ownmusic player that meets your exact needs.

Feel free to issue PRs if you need new functionality in Shiva.

15

https://github.com/tooxie/shiva-client

https://github.com/instant-solutions/shiva4j

https://github.com/gonz/shakti


16 Chapter 7. Clients

CHAPTER 8

Resources

You have the following resources available:

• /artists

• /artist/<int:artist_id>

• /artist/<int:artist_id>/shows

• /albums

• /album/<int:album_id>

• /tracks

• /track/<int:track_id>

• /track/<int:track_id>/lyrics

And some meta resources:

• /random/<str:resource_name>

• /whatsnew

• /clients

• /about

8.1 Artists Resource

Example response for the request GET /artist/3:

{"name": "Eterna Inocencia","image": "http://userserve-ak.last.fm/serve/_/8339787/Eterna+Inocencia+Eterna.jpg","uri": "/artist/3","slug": "eterna-inocencia","id": 3

}

8.1.1 Fields

• id: The object’s ID.

17


• image: Link to a photo. (Provided by last.fm)

• name: The artist’s name.

• slug: A slug of the artist’s name.

• uri: The URI of this resource’s instance.

8.2 Shows Resource

Information provided by BandsInTown. This is the only resource that is not cached in the local database given to it’sdynamic nature.

Example response for the request GET /artist/1/shows:

[{

"other_artists": [{

"mbid": "5c210861-2ce2-4be3-9307-bbcfc361cc01","facebook_tour_dates_url": "http://bnds.in/kVwY1Y","image_url": "http://www.bandsintown.com/Pennywise/photo/medium.jpg","name": "Pennywise",

}],"artists": [

{"id": 1,"uri": "/artist/1"

}],"tickets_left": true,"title": "Lagwagon @ Commodore Ballroom in Vancouver, Canada","venue": {

"latitude": "49.2805760","name": "Commodore Ballroom","longitude": "-123.1207430"

},"id": "6041814","datetime": "Thu, 21 Feb 2013 19:00:00 -0000"

}]

8.2.1 Fields

• other_artists: A list with artists that are not in Shiva’s database.

– mbid: MusicBrainz.org ID.

– facebook_tour_dates_url: URI to BandsInTown’s Facebook app for this artist.

– image_url: URI to an image of the artist.

– name: Name of the artist.

• artists: A list of artist resources.

• tickets_left: A boolean representing the availability (or not) of tickets for the concert.

18 Chapter 8. Resources

https://en.wikipedia.org/wiki/Slug_(web_publishing)#Slug

http://www.bandsintown.com/


• title: The title of the event.

• venue: A structure identifying the venue where the event takes place.

– latitude: Venue’s latitude.

– name: Venue’s name.

– longitude: Venue’s longitude.

• id: BandsInTown’s ID for this event.

• datetime: String representation of the date and time of the show.

8.2.2 Parameters

The Shows resource accepts, optionally, two pairs of parameters:

• latitude and longitude

• country and city

By providing one of this two pairs you can filter down the result list only to a city. If only one of the pair is provided(e.g., only city) will be ignored, and if both pairs are provided, the coordinates will take precedence.

8.3 Albums Resource

Example response for the request GET /album/9:

{"artists": [


},{

"id": 5,"uri": "/artist/5"

}],"name": "NOFX & Rancid - BYO Split Series (Vol. III)","year": 2002,"uri": "/album/9","cover": "http://userserve-ak.last.fm/serve/300x300/72986694.jpg","id": 9,"slug": "nofx-rancid-byo-split-series-vol-iii"

}

8.3.1 Fields

• artists: A list of the artists involved in that record.

• cover: A link to an image of the album’s cover. (Provided by last.fm)


• name: The album’s name.

• slug: A slug of the album’s name.

8.3. Albums Resource 19




• year: The release year of the album.

8.3.2 Filtering

The album list accepts an artist parameter in which case will filter the list of albums only to those correspondingto that artist.

Example response for the request GET /albums/?artist=7:

[{

"artists": [{


}],"name": "Anesthesia","year": 1995,"uri": "/album/12","cover": "http://userserve-ak.last.fm/serve/300x300/3489534.jpg","id": 12,"slug": "anesthesia"

},{

"artists": [{


}],"name": "Kum Kum","year": 1996,"uri": "/album/27","cover": "http://userserve-ak.last.fm/serve/300x300/62372889.jpg","id": 27,"slug": "kum-kum"

}]

8.4 Track Resource

Example response for the request GET /track/510:

{

"number": 4,"bitrate": 128,"slug": "dinosaurs-will-die","album": {

"id": 35,"uri": "/album/35"

},"title": "Dinosaurs Will Die",



"artist": {"id": 2,"uri": "/artist/2"

},"uri": "/track/510","id": 510,"length": 180,"files": {

"audio/mp3": "http://localhost:8080/nofx-pump_up_the_valuum/04. Dinosaurs Will Die.mp3","audio/ogg": "/track/510/convert?mimetype=audio%2Fogg"

}

}

8.4.1 Fields

• album: The album to which this track belongs.

• bitrate: In MP3s this value is directly proportional to the sound quality.


• length: The length in seconds of the track.

• number: The ordinal number of this track with respect to this album.

• slug: A slug of the track’s title.

• title: The title of the track.


• files: A list of URIs to access the files in the different formats, according to the MEDIA_DIRS setting.

8.4.2 Filtering

The track listing accepts one of two possible parameters to filter down the list only to those tracks corresponding to agiven album or artist.

By artist

Example response for the request GET /tracks?artist=16:

[{

"number": 1,"bitrate": 196,"slug": "pay-cheque-heritage-ii","album": {

"id": 36,"uri": "/album/36"

},"title": "Pay Cheque (Heritage II)","artist": {

"id": 16,"uri": "/artist/16"

},

8.4. Track Resource 21

https://en.wikipedia.org/wiki/Bit_rate#MP3

https://en.wikipedia.org/wiki/Ordinal_number



"uri": "/track/523","id": 523,"length": 189,"files": {

"audio/mp3": "http://localhost:8080/ftd-2003-sofa_so_good/01 For The Day - Pay Cheque (Heritage II).mp3","audio/ogg": "/track/523/convert?mimetype=audio%2Fogg"

}},{

"number": 2,"bitrate": 186,"slug": "in-your-dreams","album": {

"id": 36,"uri": "/album/36"

},"title": "In Your Dreams","artist": {

"id": 16,"uri": "/artist/16"

},"uri": "/track/531","id": 531,"length": 171,"files": {

"audio/mp3": "http://localhost:8080/ftd-2003-sofa_so_good/02 For The Day - In Your Dreams.mp3","audio/ogg": "/track/523/convert?mimetype=audio%2Fogg"

}}

]

By album

Example response for the request GET /tracks?album=18:

[

{"album": {

"id": 18,"uri": "/album/18"

},"length": 132,"files": {

"audio/mp3": "http://localhost:8080/flip-keep_rockin/flip-01-shapes.mp3","audio/ogg": "/track/277/convert?mimetype=audio%2Fogg"

}"number": 1,"title": "Shapes","slug": "shapes","artist": {


},"bitrate": 192,"id": 277,"uri": "/track/277"



},{

"album": {"id": 18,"uri": "/album/18"


"audio/mp3": "http://localhost:8080/flip-keep_rockin/flip-02-stucked_to_the_ground.mp3","audio/ogg": "/track/281/convert?mimetype=audio%2Fogg"

}"number": 2,"title": "Stucked to The Ground","slug": "stucked-to-the-ground","artist": {



}]

8.5 Lyrics Resource

Example response for the request GET /track/256/lyrics:

{"track": {

"id": 256,"uri": "/track/256"

},"source_uri": "http://lyrics.com/eterna-inocencia/my-family/","id": 6,"uri": "/lyrics/6"

}

8.5.1 Fields


• source_uri: The URI where the lyrics were fetched from.

• track: The track for which the lyrics are.


8.5.2 Adding more lyric sources

Everytime you request a lyric, Shiva checks if there’s a lyric associated with that track in the database. If it’s there itwill immediately retrieve it, otherwise will iterate over a list of scrapers, asking each one of them if they can fetch it.This list is in your local config file and looks like this:

8.5. Lyrics Resource 23


SCRAPERS = {'lyrics': (

'modulename.ClassName',),

}

This will look for a class ClassName in shiva/lyrics/modulename.py. If more scrapers are added, eachone of them is called sequentially, until one of them finds the lyrics and the rest are not executed.

Adding scrapers

If you want to add your own scraper just create a file under the lyrics directory, let’s say mylyrics.py with thisstructure:

from shiva.lyrics import LyricScraper

class MyLyricsScraper(LyricScraper):""" Fetches lyrics from mylyrics.com """

def fetch(self, artist, title):# Magic happens here

if not lyrics:return False

self.lyrics = lyricsself.source = lyrics_url

return True

And then add it to the scrapers list:

SCRAPERS = {'lyrics': (

'modulename.ClassName','mylyrics.MyLyricsScraper',

),}

Remember that the fetch() method has to return True in case the lyrics were found or False otherwise. It mustalso store the URL where they were fetched from in self.source. That’s where Shiva looks for the information.

Shiva will not store the actual lyrics, only the URI where the lyric was found.

For more details check the source of the other scrapers.

8.6 The fulltree modifier

The three main resources accept a fulltree parameter when retrieving an instance. Those are:

• /artist/<int:artist_id>

• /album/<int:album_id>

• /tracks

• /track/<int:track_id>



Whenever you set fulltree to any value that evaluates to True (i.e., any string except ’false’ and ’0’) Shivawill include not only the information of the object you are requesting, but also the child objects.

Here’s an example response for the request GET /artist/2?fulltree=true:

{"name": "Eterna Inocencia","image": "http://userserve-ak.last.fm/serve/_/8339787/Eterna+Inocencia+Eterna.jpg","uri": "/artist/2","events_uri": null,"id": 2,"slug": "eterna-inocencia","albums": [

{"artists": [


}],"name": "Tomalo Con Calma EP","year": 2002,"uri": "/album/2","cover": "http://spe.fotolog.com/photo/30/54/51/alkoldinamita/1230537010699_f.jpg","id": 2,"slug": "tomalo-con-calma-ep","tracks": [

{"album": {

"id": 2,"uri": "/album/2"


"audio/mp3": "http://127.0.0.1:8001/eterna_inocencia/tomalo-con-calma.mp3","audio/ogg": "/track/27/convert?mimetype=audio%2Fogg"

}"number": 0,"title": "02 - Rio Lujan","slug": "02-rio-lujan","artist": {



},{

"album": {"id": 2,"uri": "/album/2"


"audio/mp3": "http://127.0.0.1:8001/eterna_inocencia/estoy-herido-en-mi-interior.mp3","audio/ogg": "/track/28/convert?mimetype=audio%2Fogg"

}"number": 0,

8.6. The fulltree modifier 25


"title": "03 - Estoy herido en mi interior","slug": "03-estoy-herido-en-mi-interior","artist": {



},]

}]

}

8.6.1 Using fulltree on tracks

The behaviour on a track resource is a little different. In the previous example tracks are the leaves of the tree, butwhen the full tree of a track is requested then all the scraped resources are also included, like lyrics.

This is not the default behaviour to avoid DoS’ing scraped websites when fetching the complete discography of anartist.

Note that if you request the list of tracks with fulltree, only the related resources will be included (i.e.: artists andalbums) but not the scraped ones.

8.7 Pagination

All the listings are not paginated by default. Whenever you request a list of either artists, albums or tracks the serverwill retrieve every possible result unless otherwise specified.

It is possible to paginate results by passing the page_size and the page parameters to the resource. They must bothbe present and be positive integers. If not, they will both be ignored and the whole set of elements will be retrieved.

An example request is GET /artists?page_size=10&page=3.

8.8 Using slugs instead of IDs

It is possible to use slugs instead of IDs when requesting an specific resource. It will work the exact same way becauseslugs, as IDs, are unique. An example on the /artist resource:

Example response for the request GET /artist/eterna-inocencia:

{"name": "Eterna Inocencia","image": "http://userserve-ak.last.fm/serve/_/8339787/Eterna+Inocencia+Eterna.jpg","uri": "/artist/3","slug": "eterna-inocencia","id": 3

}



8.9 Uniqueness of slugs

Slugs are generated from the following fields:

• Artist.name

• Album.name

• Track.title

If the slug clashes with an existing one, then a hyphen and a unique ID will be appended to it. Due to the possibility ofusing slugs instead of IDs, if an slug results in a numeric string a hyphen and a unique ID will be appended to removethe ambiguity.

8.10 Random resources

You can request a random instance of a given resource for artists, albums or tracks. To do so you need to issue a GETrequest on one of the following resources:

• /random/artist

• /random/album

• /random/track

They all will return a consistent structure containing id and uri, as in this example response for the request GET/random/artist:


}

You will have to issue another request to obtain the details of the instance.

8.9. Uniqueness of slugs 27



CHAPTER 9

Format conversion

No matter in which format files were indexed, it is possible to convert tracks to serve them in different formats. Forthis you are going to need ffmpeg installed in your system.

If you have fmpeg compiled but not installed, you can give Shiva the path to the binary in a setting, in this format:

FFMPEG_PATH = '/usr/bin/ffmpeg'

You will notice that track objects contain a files attribute:

{"id": 510,"uri": "/track/510","files": {

"audio/mp3": "http://localhost:8080/nofx-pump_up_the_valuum/04. Dinosaurs Will Die.mp3","audio/ogg": "/track/510/convert?mimetype=audio%2Fogg"

}}

In that attribute you will find a list of all the supported formats. That list is generated from the MIMETYPES setting(see The MIMETYPES config). Just follow the link of the format you need and Shiva will convert it if necessary andserve it for you. As a client, that’s all you care about.

But you may have noticed that the URI for the audio/ogg format goes through Shiva. This is because the file hasnot been yet converted, once you call that URI, Shiva will convert the file on the fly, cache it and redirect to the file.The next time the same track is requested, if the file exists it will be served through the file server instead of Shiva:

{"id": 510,"uri": "/track/510","files": {

"audio/mp3": "http://localhost:8080/nofx-pump_up_the_valuum/04. Dinosaurs Will Die.mp3","audio/ogg": "http://localhost:8080/nofx-pump_up_the_valuum/04. Dinosaurs Will Die.ogg"

}}

It’s completely transparent for the client. If you want an OGG file, you just follow the “audio/ogg” URI blindly, andyou will get your file. The first time will take a little longer, though.

9.1 Absolute paths

If you need absolute paths for your /convert URIs, just set the SERVER_URI setting in your local config, it willbe prepended to all the URIs:

29


SERVER_URI = 'http://127.0.0.1:9002'

Example output:

{"files": {

"audio/mp3": "http://127.0.0.1:8001/flip-keep_rockin/flip-10-away_from_the_sun.mp3","audio/ogg": "http://127.0.0.1:9002/track/1/convert?mimetype=audio%2Fogg"

},"album": {

"id": 1,"uri": "http://127.0.0.1:9002/album/1"

},"length": 168,"number": 10,"title": "Away From The Sun","slug": "away-from-the-sun","artist": {

"id": 1,"uri": "http://127.0.0.1:9002/artist/1"

},"bitrate": 192000,"id": 1,"uri": "http://127.0.0.1:9002/track/1"

}

Remember to leave out trailing slashes.

9.2 Your converter sucks

So, you don’t want to use ffmpeg, or you want to call it with different parameters, or chache files differently. That’sok, I won’t take it personally.

To overwrite the Converter class to use, just define it in your config:

from shiva.myconverter import MyBetterConverter

CONVERTER_CLASS = MyBetterConverter

One option is to extend shiva.converter.Converter and overwrite the methods that offend you.

The other option is to write a completely new Converter class. If you do so, make sure to have at least the following 3methods:

• __init__(Track track, (str, MimeType) mimetype): Constructor accepting a path to a fileand a mimetype, which could be a string in the form of ‘type/subtype’, or a MimeType instance.

• convert(): Converts to a different format.

• get_uri(): Retrieves the URI to the converted file.

The shiva.resources.ConvertResource class makes use of them.

9.3 The MimeType class

All mimetypes are represented by a shiva.media.MimeType class. The constructor receives the following pa-rameters:

30 Chapter 9. Format conversion


• type: Would be audio in audio/ogg.

• subtype: Would be ogg in audio/ogg.

• extension: The extension that converted files should have.

• acodec and/or vcodec: The codecs used by Converter.convert(). Find out the available codecsrunning:

$ ffmpeg -codecs

9.3.1 The MIMETYPES config

You will see in your config file:

MIMETYPES = (MimeType(type='audio', subtype='mp3', extension='mp3',

acodec='libmp3lame'),MimeType(type='audio', subtype='ogg', extension='ogg',

acodec='libvorbis'),)

Keep in mind that an invalid MimeType in this config will raise an InvalidMimeTypeError exception.

9.3. The MimeType class 31


32 Chapter 9. Format conversion

CHAPTER 10

What’s new?

There’s a special resource that lets you query the database to retrieve all the resources older than a given date, at thesame time:

/whatsnew?since=YYYYMMDD

This will return an object with the following format:

{"artists": [],"albums": [

{"id": 10,"uri": "/album/10"

}],"tracks": [

{"id": 121,"uri": "/track/121"

},{

"id": 122,"uri": "/track/122"

}],

}

33


34 Chapter 10. What’s new?

CHAPTER 11

Cross Origin Resource Sharing

CORS support is disabled by default because it’s a browser-specific feature, and Shiva doesn’t assume that the clientsare browsers.

To enable CORS you have to set the following in your local.py file:

CORS_ENABLED = True

Now Shiva will add the following header to each response:

Access-Control-Allow-Origin: *Access-Control-Allow-Headers: Accept, Content-Type, Origin, X-Requested-With

If you want to limit it to a single origin, then define a tuple with the accepted domains:

CORS_ALLOWED_ORIGINS = ('napster.com', 'slsknet.org')

Or simply a string:

CORS_ALLOWED_ORIGINS = 'napster.com'

When a domain (or a tuple of domains) is defined, Shiva will check the request against it. If they match, a header isadded:

Access-Control-Allow-Origin: http://napster.com

35

http://de.wikipedia.org/wiki/Cross-Origin_Resource_Sharing


36 Chapter 11. Cross Origin Resource Sharing

CHAPTER 12

Want to contribute?

There are many ways you can contribute:

• File bug reports.

• Implement new features.

• Build your own client.

• Write documentation.

• Write tests.

• Talk about Shiva.

– Write an article.

– Give a talk.

• Use it!

If you build a client or write an article about Shiva, let us know and we’ll include it in our documentation.

12.1 Sending code

If you want to implement a new feature or fix a bug, remember that every PR that you issue must:

• Strictly follow the PEP8.

• Include documentation, if applicable.

– Detailed documentation of the new feature.

– Update old documentation for functionality changes.

• Include tests.

• Not break previous tests.

The CI tool will check for most of this, so make sure the build passes.

37

http://www.python.org/dev/peps/pep-0008/

https://travis-ci.org/tooxie/shiva-server


38 Chapter 12. Want to contribute?

CHAPTER 13

Bug Reports

Please report bugs, recommend enhancements or ask questions in our issue tracker. Before reporting bugs please makesure of the following:

• The bug was not previously reported.

• You have the latest version installed.

• The bug is not actually a feature.

39

https://github.com/tooxie/shiva-server/issues


40 Chapter 13. Bug Reports

CHAPTER 14

Assumptions

For the sake of simplicity many assumptions were made that will eventually be worked on and improved/removed.

• Only music files. No videos. No images.

• No users.

– Therefore, no customization.

– And no privacy.

• No uploading of files.

• No update of files’ metadata when DB info changes.

41


42 Chapter 14. Assumptions

CHAPTER 15

Wish list

This is a (possible incomplete) list of ideas that may be eventually implemented. With time we will see which of themmake sense (or not) and work on them (or not). We may add things that are not documented here as well.

• Index also images and videos.

• Batch-edit ID3 tags.

• Download your tracks in batch.

• Users.

– Favourite artists.

– Playlists.

– Play count.

• Share your music with your friends.

• Share your music with your friends’ servers.

• Listen to your friends’ music.

• They can also upload their music.

• Stream audio and video. (Radio mode)

• Set up a radio and collaboratively pick the music. (Would this belong to Shiva or to another service consumingShiva’s API?)

• Tabs.

43


44 Chapter 15. Wish list

CHAPTER 16

Disclaimer

Remember that when using this software you must comply with your country’s laws. You and only you will be heldresponsible for any law infringement resulting from the misuse of this software.

That said. Have fun.

45


46 Chapter 16. Disclaimer

CHAPTER 17

Why Shiva?

Shiva is the name of the crater that would have been created by the K-Pg event that extincted the dinosaurs.

47

https://en.wikipedia.org/wiki/Shiva_crater

https://en.wikipedia.org/wiki/Cretaceous%E2%80%93Paleogene_extinction_event

https://www.youtube.com/watch?v=dlAeN3Qxlvc

Date post:	30-Apr-2020
Category:	Documents
Upload:	others
View:	2 times
Download:	0 times

May 25, 2015 · pluuft api Documentation, Release stable Dinosaurs will slowly die. Contents 1

Documents