MusicBottle: Difference between revisions
(More Bottle development links.) |
(Rewrite the introduction and fix some naming issues.) |
||
Line 1: | Line 1: | ||
'''MusicBottle''' (or "the |
'''MusicBottle''' (or "the Bottle") is a project with the intend of presenting [[MusicBrainz]] data in a way more suitable for presentation and browsing where musicbrainz.org is mostly for editing purposes. It is led by [[User:Freso|Freso]] and [[User:Caller_number_six|caller#6]] with contributions from [[User:LordSputnik|Lordsputnik]] and a bunch of other the MusicBrainz people. |
||
Discussion will happen probably mostly on [[Communication/IRC|IRC]] in the room #musicbottle. Feel free to come and hang out. We will probably also utilise the mb-devel [[Communication/Mailing Lists|mailing list]] for getting feedback on some design decisions (e.g., input on how to implement caching). |
Discussion will happen probably mostly on [[Communication/IRC|IRC]] in the room #musicbottle. Feel free to come and hang out. We will probably also utilise the mb-devel [[Communication/Mailing Lists|mailing list]] for getting feedback on some design decisions (e.g., input on how to implement caching). |
||
Line 25: | Line 25: | ||
== Implementation == |
== Implementation == |
||
As Freso likes writing [http://xkcd.com/353/ Python] and |
As Freso likes writing [http://xkcd.com/353/ Python] and caller#6 wants to learn the language, this quickly became the language of the project. [http://flask.pocoo.org/ Flask] was initially recommended by ianweller and subsequently endorsed by ruaok, so that is the framework we're currently looking into. We will most likely aim for getting the code running on an nginx server. |
||
We're also going to need some kind of cache, to not hit MusicBrainz (or other sites) over and over again. We're looking into [https://en.wikipedia.org/wiki/MongoDB MongoDB] and possibly other NoSQL databases for now. |
We're also going to need some kind of cache, to not hit MusicBrainz (or other sites) over and over again. We're looking into [https://en.wikipedia.org/wiki/MongoDB MongoDB] and possibly other NoSQL databases for now. |
||
Line 80: | Line 80: | ||
Images from fanart.tv |
Images from fanart.tv |
||
== Proper name == |
|||
The "Musicbottle" name is just a codename until we decide on a proper name. Several suggestions have been thrown back and forth. General themes are music and brains (for obvious reasons), bottles/flasks (due to using Flask), and Star Trek (because of [[MusicBrainz Picard]] and CallerNo6 being an old-time trekkie). [[/Name suggestions|Suggestions are welcome.]] |
|||
== Inspiration == |
== Inspiration == |
||
Line 109: | Line 105: | ||
* [[/Tasks]] |
* [[/Tasks]] |
||
⚫ | |||
* [[/Related media]] |
* [[/Related media]] |
||
* Retired/deprecated pages |
|||
⚫ |
Revision as of 20:29, 1 January 2013
MusicBottle (or "the Bottle") is a project with the intend of presenting MusicBrainz data in a way more suitable for presentation and browsing where musicbrainz.org is mostly for editing purposes. It is led by Freso and caller#6 with contributions from Lordsputnik and a bunch of other the MusicBrainz people.
Discussion will happen probably mostly on IRC in the room #musicbottle. Feel free to come and hang out. We will probably also utilise the mb-devel mailing list for getting feedback on some design decisions (e.g., input on how to implement caching).
- Source code on GitHub.
- Code running on the MusicBrainz sandbox server. (Not guaranteed to be running.)
- Continuous integration (Jenkins) (Test results from whenever new code is pushed to GitHub.)
- @musicbottle_dev (Twitter)
- @musicbottledev (Identi.ca)
Purpoise, the Mission Statement
- Showcase the MusicBrainz data in a prettier way than what can reasonably be achieved on musicbrainz.org.
- Show what can be done using the data fetched from MusicBrainz' Web Service.
Background
(Write stuff.)
Design decisions/philosophy
- Don't hardcode any information. While it may be tempting to mark that Mozart is a composer in the code, we want the site to display the what can be retrieved using only MusicBrainz. Retrieving information from sources linked to from MB data is fine, but hardcoding such info is not.
- Use the URL scheme of musicbrainz.org as long as at makes sense. This should simplify a lot of things, and make inter-site URL mapping quite easy. So e.g. http://musicbottle.net/artist/3c25958a-2bff-4381-8eb4-7dbe84c3e75e will match https://musicbrainz.org/artist/3c25958a-2bff-4381-8eb4-7dbe84c3e75e
Implementation
As Freso likes writing Python and caller#6 wants to learn the language, this quickly became the language of the project. Flask was initially recommended by ianweller and subsequently endorsed by ruaok, so that is the framework we're currently looking into. We will most likely aim for getting the code running on an nginx server.
We're also going to need some kind of cache, to not hit MusicBrainz (or other sites) over and over again. We're looking into MongoDB and possibly other NoSQL databases for now.
The main codebase is GPL v2+ and any libraries developed to keep sane abstractions will be LGPL'd. (Any Flask-specific extensions will be BSD/MIT-style licensed.) The code is available on GitHub.
Libraries, APIs, etc.
- Web services:
- MusicBrainz: XML / JSON
- MediaWiki API
- YouTube API
- Twitter Developers
- Facebook Developers
- Bandcamp API (Terms)
- Cover Art Archive
- Fanart.tv Music API
- MySpace Developer Platform
- iTunes Search API
- Discogs API
- Flickr Machine Tag
- Last.fm API (provides lookup of artist by MBID and images for artists)
- Python libraries:
- Flask
- Flask-Babel
- Flask-PyMongo
- Flask-Testing
- Flask-Script (manage.py)
- Jinja2
- Werkzeug
- MongoDB
- Other
- Talkatv comment system (github page)
Other pointers
- Coding style (Pocoo Styleguide)
- @seealso Code Like a Pythonista: Idiomatic Python for a tour through PEP 8 and various Python "tricks".
- I18n:
- See JSON output "pretty-printed" in your browser:
Random ideas
How and what to pull in and how to present it?
Twitter, YouTube, Facebook, ... activity streams.
Images from fanart.tv
Inspiration
- CatfishSmooth
- Music Web Navigator - uses MusicBrainz and Last.FM data.
- "Moto Boy (or, how to build a beautiful and functional artist website)"
- richseam
- BBC Music artist pages (e.g. S Club (7))
- Beardscratchers Compendium of Music
Mock-up pages
- Magic Javascript MusicBrainz site thing.
- http://people.scs.carleton.ca/~cwalton3/temp/mbmockups/bs-r.html
- http://people.scs.carleton.ca/~cwalton3/temp/mbmockups/bs-rg.html
- http://people.scs.carleton.ca/~cwalton3/temp/mbmockups/release.html
- http://people.scs.carleton.ca/~cwalton3/temp/mbmockups/bs2/test.html
Other sites
- /Tasks
- /Related media
- Retired/deprecated pages