Difference between revisions of "Development/Summer of Code/2017"

From MusicBrainz Wiki
(Qt5/Py3 Port)
 
(24 intermediate revisions by 4 users not shown)
Line 1: Line 1:
This page captures our ideas for Google Summer of Code projects for 2017:
+
Are you interested in working with MetaBrainz in Google Summer of Code 2017? You're in the right place!
  
==MusicBrainz==
+
==Where to start==
 +
<dl>
 +
<dt>New to MetaBrainz?</dt>
 +
<dd>The [[meb:|MetaBrainz Foundation]] has been set up to build [[meb:projects|community maintained databases]] and make them available in the public domain or under Creative Commons licenses</dd>
 +
<dt>New to MetaBrainz development and/or GSoC?</dt>
 +
<dd>[[Development/Summer_of_Code/Getting_started|Getting started with GSoC]]</dd>
 +
<dt>Ready to apply?</dt>
 +
<dd>[https://community.metabrainz.org/c/metabrainz/gsoc-applications GSoC applications @ community.metabrainz.org]</dd>
 +
<dd>Be aware of the content of our [[Development/Summer of Code/Application Template]]</dd>
 +
</dl>
  
Bitmap: Please add ideas!
+
=== Mentors ===
  
==AcousticBrainz==
+
{| class="wikitable"
 +
|+ Mentor list
 +
! Name
 +
! [[IRC]] nick
 +
! Project
 +
|-
 +
| [[discourse_user:rob|Robert Kaye]]
 +
| ruaok
 +
| AcousticBrainz, ListenBrainz, MusicBrainz
 +
|-
 +
| [[discourse_user:bitmap|Michael Wiencek]]
 +
| bitmap
 +
| MusicBrainz, Picard
 +
|-
 +
| [[discourse_user:alatairp|Alastair Porter]]
 +
| alastairp
 +
| AcousticBrainz, ListenBrainz
 +
|-
 +
| [[discourse_user:lordsputkin|Ben Ockmore]]
 +
| LordSputnik
 +
| BookBrainz
 +
|-
 +
| [[discourse_user:leftmostcat|Sean Burke]]
 +
| Leftmost
 +
| BookBrainz
 +
|-
 +
| [[discourse_user:gentlecat|Roman Tsukanov]]
 +
| Gentlecat
 +
| CritiqueBrainz, AcousticBrainz, ListenBrainz
 +
|-
 +
| [[discourse_user:zas|Laurent Monin]]
 +
| zas
 +
| Picard
 +
|}
  
===BigQuery upload and statistics===
+
Some potential mentors are listed by each project; this is far from a normative list, but it might give you somebody to ask about the project.
  
===New machine learning infrastructure===
+
{{Note|Contacting the mentors privately (e.g., via e-mail or private IRC messages) will get you off to a very, very bad start in your relations with us and any application you send us is now almost definitely going to not get accepted.}}
  
===Storage for detailed analysis files===
+
=== About proposals ===
 +
Before you dive in and send a proposal to us through Google, it's a good idea to take some time and [[How_to_Contribute|learn about the MusicBrainz community]]. At MusicBrainz we pride ourselves for having a strong community - most of us know each other in some way, and some of us know each other face to face from development summits.
  
 +
A good way to get a feel of this would be to talk about your ideas and proposals on IRC. However, starting off by sending private messages to potential mentors '''is not''' a good way to introduce yourself to the community. '''Please don't do that!'''
  
==CritiqueBrainz==
+
If you're not sure where to start, [[Development/Summer of Code/Getting started]] might help.
  
=== Direct access to MusicBrainz database ===
+
===Join in on development===
  
Proposed mentor: ''Gentlecat''<br>
+
We like it when potential students show initiative and make contributions to code without asking us what to do next. We have tagged [https://tickets.metabrainz.org/issues/?jql=labels%20%3D%20good-first-bug tickets that we think are suitable for for new contributors with the "good-first-bug" label]. Take a look at these tickets and see if any of them grab your interest. If a ticket is not assigned to anyone you can assume that it's up for grabs - feel free to assign yourself and start working on it. We recommend that you also talk to us before starting work on a ticket, to make sure that you understand what tasks are involved to finish the ticket. We recommend that you explain to us your understanding of the ticket - we will help you if there is anything that you have missed. To talk to us, join our IRC channel or post a message in the forums or on a ticket.
Languages/skills: Python, Flask, SQL (PostgreSQL, SQLAlchemy), Docker, Consul
 
  
So far, the biggest cause for slowdown in CritiqueBrainz are requests to MusicBrainz web service. It's not that MusicBrainz WS is slow, it's just that some pages on CritiqueBrainz require a lot of MusicBrainz data, which might take a very long time to retrieve. This can be caused by the complexity of a request, or by a number of them (when showing multiple items, since there's no way to do batch-requests).
+
==Projects==
 +
===[[AcousticBrainz]]===
  
New infrastructure allows us to easily read data directly from the MusicBrainz database. Doing this in CritiqueBrainz will probably be a significant speedup.
+
{| style="width:60%"
 +
|-
 +
| style="width:120px" rowspan="3" | [[File:AcousticBrainz logo small notext.png]]
 +
| AcousticBrainz is our new project that crowdsources acoustic information for all music in the world and to make it available to the public. We already have low-level information about more than three million tracks. What we need is a good way for users and developers to interact with all this data and help improve algorithms that are used to analyze it.
  
See https://tickets.metabrainz.org/browse/CB-231.
+
It would suit someone with experience or an interest in machine learning algorithms, though the majority of the project will probably involve creating infrastructure around our existing algorithms.
 +
|-
 +
| style="background-color:ghostwhite" | '''Languages/skills''': Python, PostgreSQL, Flask
 +
|-
 +
| style="text-align:center" | [[Development/Summer of Code/2017/AcousticBrainz|Ideas page]] | [http://acousticbrainz.org/ Main page] | [http://blog.musicbrainz.org/category/acousticbrainz/ Blog] | [[discourse:c/acousticbrainz|Forums]]
 +
|}
 +
<hr />
  
=== Book reviews ===
+
===[[BookBrainz]]===
 +
{| style="width:60%"
 +
|-
 +
| style="width:120px" rowspan="3" | [[File:BookBrainz logo small notext.png]]
 +
| BookBrainz is a database of book metadata.
  
Proposed mentor: ''Gentlecat''<br>
+
This year we're interested in projects that help us get more data. The three suggested ideas to build proposals around are data importing, a web API and gamification of editing. Please see our sub-project ideas page for information on getting started and more details about the ideas themselves.
Languages/skills: Python, Flask, SQL (PostgreSQL, SQLAlchemy), JavaScript
+
|-
 +
| style="background-color:ghostwhite" | '''Top 3 Desired Skills''': Node.js, Python, SQL
 +
|-
 +
| style="text-align:center" | [[Development/Summer of Code/2017/BookBrainz|Ideas page]] | [[bb:|Main page]] | [[discourse:c/bookbrainz|Forums]]
 +
|}
 +
<hr />
  
Currently people can review release groups, events, and places. We'd like to expand that list by allowing people to publish reviews for books. Metadata about books can be retrieved from the BookBrainz project (by accessing the web API or its database directly). This project would require (1) extension of CritiqueBrainz back-end to support book reviews, and (2) changes to the web interface.
+
===[[CritiqueBrainz]]===
 +
{| style="width:60%"
 +
|-
 +
| style="width:120px" rowspan="3" | [[File:CritiqueBrainz logo small notext.png]]
 +
| Fills the gap between music critics and raw data by providing a platform created for the sole purpose of Creative Commons licensed reviews.
 +
|-
 +
| style="background-color:ghostwhite" | '''Languages/skills''': Python, Flask, SQL, PostgreSQL
 +
|-
 +
| style="text-align:center" | [[Development/Summer of Code/2017/CritiqueBrainz|Ideas page]] | [[cb:|Main page]] | [[discourse:c/metabrainz|Forums]]
 +
|}
 +
<hr />
  
See https://tickets.metabrainz.org/browse/CB-240.
+
===[[ListenBrainz]]===
 +
{| style="width:60%"
 +
|-
 +
| style="width:120px" rowspan="3" | [[File:ListenBrainz logo small notext.png]]
 +
| An open source music website that allows users to import their listen history. One of the goals is for this data to be used for building open music recommendation systems.
 +
|-
 +
| style="background-color:ghostwhite" | '''Languages/skills''': Python
 +
|-
 +
| style="text-align:center" | [[Development/Summer of Code/2017/ListenBrainz|Ideas page]] | [https://listenbrainz.org/ Main page]
 +
|}
 +
<hr />
  
==ListenBrainz==
+
===[[MusicBrainz]]===
 +
{| style="width:60%"
 +
|-
 +
| style="width:120px" rowspan="3" | [[File:MusicBrainz logo small notext.png]]
 +
| A community-maintained open source music encyclopedia that collects music metadata and makes it available to the public.
 +
|-
 +
| style="background-color:ghostwhite" | '''Languages/skills''': JavaScript (React), Perl, Python, PostgreSQL, SQL
 +
|-
 +
| style="text-align:center" | [[Development/Summer of Code/2017/MusicBrainz|Ideas page]] | [[mb:|Main page]] | [[discourse:c/musicbrainz|Forums]]
 +
|}
 +
<hr />
  
=== Create charts/graphs for user behaviour ===
+
===[[MusicBrainz Picard]]===
 +
{| style="width:60%"
 +
|-
 +
| style="width:120px" rowspan="3" | [[File:Picard_logo_small_notext.png]]
 +
| '''MusicBrainz Picard''' is a cross-platform (Linux/Mac OS X/Windows) application written in Python and is the official MusicBrainz [[MusicBrainz_Enabled_Applications|tagger]]. It supports the majority of audio file formats, is capable of using audio fingerprints ([[AcoustID]]s), performing CD lookups and [[Disc ID|disc ID]] submissions, and it has excellent Unicode support.
 +
|-
 +
| style="background-color:ghostwhite" | '''Languages/skills''': Python, QT
 +
|-
 +
| style="text-align:center" | [[Development/Summer of Code/2017/Picard|Ideas page]] | [https://picard.musicbrainz.org/ Main page] | [[discourse:c/picard|Forums]]
 +
|}
 +
<hr />
  
Proposed mentors:''mayhem'', ''alastairp''<br>
+
[[Category:Development]]
Languages/skills: Python, Flask, BiqQuery, InfluxDB, data science, graphing, visualization, data architecture
 
 
 
ListenBrainz is preparing to stream its listen data to Big Query where anyone can have access to it in real time. From this data that is stored in BigQuery we wish to have a student build a general charting/graphing system that allows future contributors to explore the data with BigQuery. Any user should be able to craft a query that can be turned into a graph/visualization on the ListenBrainz site, with minimal effort. If a user crafts an interesting query, they should be able to open a pull request and supply the details of the query in order for the LB team to add this graph to the site.
 
 
 
This project requires building the behind the scenes BigQuery access, caching, periodic updates and synchronization between the ListenBrainz server and the BigQuery data store.
 
 
 
=== A way to associate listens with MBIDs ===
 
 
 
Proposed mentors: ruaok, alastairp, gentlecat<br>
 
Languages/skills: Python<br>
 
[https://community.metabrainz.org/c/metabrainz Forum for discussion]
 
 
 
Last.fm is broken because of the terrible way it handles metadata (artists with the same name are jumbled into a single page; at the same time, there are often multiple pages for the same artist/album/track due to spelling variations). ListenBrainz is smarter by taking advantage of MBIDs. But there needs to be some sort of interface for identifying listens as being for a particular track (or recording) MBID. This could allow the user to identify an album they listened to on Spotify as the same one they listen to in iTunes a few days later. Then they wouldn't remain separate artists or albums in the stats due to differences in metadata alone.
 
 
 
==BookBrainz==
 
=== Data Importing ===
 
 
 
Proposed mentors: ''LordSputnik'' or ''Leftmost''<br>
 
Languages/skills: Browser JS, Node.js or Python, SQL/PostgreSQL<br>
 
[https://community.metabrainz.org/c/bookbrainz Forum for discussion]
 
 
 
At last year's summit, the two BookBrainz lead developers, Leftmost and LordSputnik worked on a plan for importing third party data into BookBrainz. This plan has several stages. First, data sources need to be identified, including mass import sources with freely available data, such as libraries, and manual import sources, such as online book stores and other user-contributed databases. The next stage is to update the database to introduce an "Import" object, which can be used to distinguish mass imported data from (usually better quality) user contributions. Then, actual import bots for mass import and userscripts for manual import will need to be written. Finally, it would desirable (but not necessary if time is short) to introduce an interface to the BookBrainz site to allow users to review automatically imported data, and approve it.
 
 
 
=== Web API ===
 
 
 
Proposed Mentors: ''LordSputnik''/''Leftmost''<br>
 
Languages/skills: Node.js, ES6, Python, Redis, OAuth<br>
 
[https://community.metabrainz.org/c/bookbrainz Forum for discussion]
 
 
 
We’re currently in the process of switching to using Node.js for all server side code. As part of this, our schema has been redesigned, and the current Python-based web API will no longer work.
 
 
 
We'd like a new and improved JSON web API to be designed and implemented. The design would clearly describe the result of each different query to the web API, and give examples of output. It would also describe the workings of any additional features to be implemented - for example, authentication, caching and rate limiting. Authentication in the web API is a particular challenge, since the current MB OAuth setup requires a GUI.
 
 
 
The web API should be written using the koa.js Node.js server framework, so that the resulting code is as clean and minimal as possible. Tests should be written in parallel with the implementation, adapting and expanding on the tests for the existing Python web API. The priority for this task is a solid plan and quality code, not a complete implementation (although that would be nice!)
 
 
 
==MusicBrainz Picard==
 
 
 
=== Qt5/Py3 Port ===
 
 
 
Proposed Mentors: ''zas''/''bitmap''<br>
 
Languages/skills: Python, PyQt5<br>
 
 
 
Picard is going to be receiving a complete make-over code/feature/UI wise for v2.0.
 
A part of the v2.0 plans is porting the existing code to PyQt5/Py3 from PyQt4/py2 to allow for future support and better encoding compatibility along with new features of Qt5(such as High DPI scaling, better Widget and networking support and better cross-platform compatibility) and along with all the bug fixes that come with PyQt5 which will help cleaning up the code-base for Picard.
 
 
 
For more information see:
 
 
 
[https://tickets.metabrainz.org/browse/PICARD-588 PICARD-588]
 
 
 
[https://tickets.metabrainz.org/browse/PICARD-960 PICARD-960]
 

Latest revision as of 10:44, 13 March 2017

Are you interested in working with MetaBrainz in Google Summer of Code 2017? You're in the right place!

Where to start

New to MetaBrainz?
The MetaBrainz Foundation has been set up to build community maintained databases and make them available in the public domain or under Creative Commons licenses
New to MetaBrainz development and/or GSoC?
Getting started with GSoC
Ready to apply?
GSoC applications @ community.metabrainz.org
Be aware of the content of our Development/Summer of Code/Application Template

Mentors

Mentor list
Name IRC nick Project
Robert Kaye ruaok AcousticBrainz, ListenBrainz, MusicBrainz
Michael Wiencek bitmap MusicBrainz, Picard
Alastair Porter alastairp AcousticBrainz, ListenBrainz
Ben Ockmore LordSputnik BookBrainz
Sean Burke Leftmost BookBrainz
Roman Tsukanov Gentlecat CritiqueBrainz, AcousticBrainz, ListenBrainz
Laurent Monin zas Picard

Some potential mentors are listed by each project; this is far from a normative list, but it might give you somebody to ask about the project.

Note: Contacting the mentors privately (e.g., via e-mail or private IRC messages) will get you off to a very, very bad start in your relations with us and any application you send us is now almost definitely going to not get accepted.

About proposals

Before you dive in and send a proposal to us through Google, it's a good idea to take some time and learn about the MusicBrainz community. At MusicBrainz we pride ourselves for having a strong community - most of us know each other in some way, and some of us know each other face to face from development summits.

A good way to get a feel of this would be to talk about your ideas and proposals on IRC. However, starting off by sending private messages to potential mentors is not a good way to introduce yourself to the community. Please don't do that!

If you're not sure where to start, Development/Summer of Code/Getting started might help.

Join in on development

We like it when potential students show initiative and make contributions to code without asking us what to do next. We have tagged tickets that we think are suitable for for new contributors with the "good-first-bug" label. Take a look at these tickets and see if any of them grab your interest. If a ticket is not assigned to anyone you can assume that it's up for grabs - feel free to assign yourself and start working on it. We recommend that you also talk to us before starting work on a ticket, to make sure that you understand what tasks are involved to finish the ticket. We recommend that you explain to us your understanding of the ticket - we will help you if there is anything that you have missed. To talk to us, join our IRC channel or post a message in the forums or on a ticket.

Projects

AcousticBrainz

AcousticBrainz logo small notext.png AcousticBrainz is our new project that crowdsources acoustic information for all music in the world and to make it available to the public. We already have low-level information about more than three million tracks. What we need is a good way for users and developers to interact with all this data and help improve algorithms that are used to analyze it.

It would suit someone with experience or an interest in machine learning algorithms, though the majority of the project will probably involve creating infrastructure around our existing algorithms.

Languages/skills: Python, PostgreSQL, Flask
Ideas page | Main page | Blog | Forums

BookBrainz

BookBrainz logo small notext.png BookBrainz is a database of book metadata.

This year we're interested in projects that help us get more data. The three suggested ideas to build proposals around are data importing, a web API and gamification of editing. Please see our sub-project ideas page for information on getting started and more details about the ideas themselves.

Top 3 Desired Skills: Node.js, Python, SQL
Ideas page | Main page | Forums

CritiqueBrainz

CritiqueBrainz logo small notext.png Fills the gap between music critics and raw data by providing a platform created for the sole purpose of Creative Commons licensed reviews.
Languages/skills: Python, Flask, SQL, PostgreSQL
Ideas page | Main page | Forums

ListenBrainz

ListenBrainz logo small notext.png An open source music website that allows users to import their listen history. One of the goals is for this data to be used for building open music recommendation systems.
Languages/skills: Python
Ideas page | Main page

MusicBrainz

MusicBrainz logo small notext.png A community-maintained open source music encyclopedia that collects music metadata and makes it available to the public.
Languages/skills: JavaScript (React), Perl, Python, PostgreSQL, SQL
Ideas page | Main page | Forums

MusicBrainz Picard

Picard logo small notext.png MusicBrainz Picard is a cross-platform (Linux/Mac OS X/Windows) application written in Python and is the official MusicBrainz tagger. It supports the majority of audio file formats, is capable of using audio fingerprints (AcoustIDs), performing CD lookups and disc ID submissions, and it has excellent Unicode support.
Languages/skills: Python, QT
Ideas page | Main page | Forums