Difference between revisions of "User:Ianmcorvidae/Developer Resources"

From MusicBrainz Wiki
m
 
(5 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
; [[python-musicbrainz2]]
 
; [[python-musicbrainz2]]
A client library written in Python which provides easy object oriented access to the MusicBrainz database using the [[XML Web Service|XML web service]].
+
An '''outdated''' client library written in Python which provides easy object oriented access to the MusicBrainz database using the [[XML Web Service|XML web service]] version 1. (for version 2, it is recommended you use the XML directly until [[python-musicbrainz3|an updated library]] is completed)
  
 
; [[libdiscid]]
 
; [[libdiscid]]
 
:  A C library for creating MusicBrainz disc IDs from audio CDs.
 
:  A C library for creating MusicBrainz disc IDs from audio CDs.
 +
:: See also: [[Disc ID Calculation]].
  
 
; [[libmusicbrainz]]  
 
; [[libmusicbrainz]]  
:  A development library geared towards developers who wish to add MusicBrainz lookup capabilities to their applications.
+
:  A C development library geared towards developers who wish to add MusicBrainz lookup capabilities to their applications.
  
 
== Developer documentation ==
 
== Developer documentation ==
  
 
; [[XML Web Service|XML web service]]
 
; [[XML Web Service|XML web service]]
:  The new, REST-based webservice API for direct access to MusicBrainz data (Please review the libraries above before writing your own implementation).
+
:  The REST-based webservice API for direct access to MusicBrainz data (Please review the libraries above before writing your own implementation).
 +
:: '''See also:''' [[XML Web Service/Version 2/examples|Examples]]
 +
:: [[Next Generation Schema/SearchServerXML|Search query/XML information]] and [[Text Search Syntax]]
 +
:: [http://svn.musicbrainz.org/mmd-schema/trunk/schema/musicbrainz_mmd-2.0.rng RelaxNG schema]
 +
:: [[User:OliverCharles/RE_POST|Release Editor Seeding]]: Providing programmatic information to the release editor (from another site or an application), the closest we have to an edit API as yet
 +
:: [[User:kuno/ws/js|'''(internal)''' JS autocomplete API]]
  
; [[Server Setup|Server setup]]
+
; [[NGS Server Setup|Server setup]]
 
: The [[MusicBrainz Server]] is not available as an executable application. Setting up the server will require you to checkout the source code and follow the INSTALL file's instructions.
 
: The [[MusicBrainz Server]] is not available as an executable application. Setting up the server will require you to checkout the source code and follow the INSTALL file's instructions.
 +
: The [[MusicBrainz Database]] contains all the metadata information available on musicbrainz.org and anyone is free to [[Database Download|download]] and make use of it (and we encourage this!). Setting it up will require access to a PostgreSQL database. See instructions as part of the Server Setup above or use [https://github.com/lalinsky/mbslave mbslave].
 +
: [[User:kuno/Server/Environment_variables|Server environment variables that may prove useful]]
 +
: [[User:kuno/Search_server_setup_for_developers|Search Server Setup]] if you're brave enough to want to try.
 +
: [[User:kuno/Testing|Some javascript testing information]]
  
; [[Database Setup|Database setup]]
+
; Embedded metadata
: The [[MusicBrainz Database]] contains all the metadata information available on musicbrainz.org and anyone is free to [[Database Download|download]] and make use of it (and we encourage this!). Setting it up will require access to a PostgreSQL database.
+
: [[Picard Tag Mapping]]: The documentation for how [[Picard]] maps concepts to tags; useful if you want to use these tags elsewhere, or if you'd like to follow the same standard.
 +
:: See also: [[ID3v2.4.0]]
 +
:: [[Disc IDs and Tagging]]
 +
:: [[MusicBrainz Identifier]]
  
; [[User:OliverCharles/RE_POST|Release Editor Seeding]]
+
; [[Picard]] Development
: For information on providing programmatic information to the release editor (from another site or an application)
+
: [[Picard_Qt/Plugin_API|Plugin API Documentation]]
[[Category:Development]] [[Category:WikiDocs Page]]
+
: [[Picard Tag Mapping]]
  
==User Documentation==
+
; Communicating with other developers:
 
+
:[[IRC]]: Here's where you ask questions of real live people, if anyone's awake. You love it, you know it.
; [[Frequently Asked Questions]]
+
: [[Mailing Lists]]: And here's where you ask if we aren't awake, or for anything style-related or needing more consideration than can be easily given in IRC.
: A set of community maintained FAQs.
+
: [[MusicBrainz Summit]]s: These happen occasionally, and people get together and talk about MusicBrainz. You should consider coming! Even if not, the discussions had here are sometimes important, and might be worth perusing.
 
 
;[[How To]]s
 
:A collection of tutorials. Lightweight, short and user-orientated step by step instructions.
 
 
 
;[[How Editing Works]] and the different [[Edit Type]]s
 
:A general introduction and detailed descriptions of each type of edit that you can possibly make to [[MusicBrainz]] data.  
 
 
 
;[[Advanced Relationships]]
 
: Documentation about [[:Category:Advanced Relationships|Advanced Relationships]], as well as all [[:Category:Relationship Class|Relationship Classes]], [[:Category:Relationship Family|Relationship Families]], and [[:Category:Relationship Type|Relationship Types]].  
 
 
 
;[[Advanced Search]]
 
:Describes the server-based search (also used by the [[MusicBrainz Tagger]]).
 
 
 
;[[MusicBrainz Terminology]]
 
:A collection of all terms the [[MusicBrainz]] community uses, what they mean, and wheter there is a wiki page explaining them.
 
 
 
;[[Release Language]]
 
:Describes the assignement of the language and script attribute to releases.
 
 
 
;[[Picard Documentation]]
 
:Documentation of [[MusicBrainz Picard]], MusicBrainz' official tagger.
 
 
 
;[[How Annotations Work]]
 
:A rudimentary page that explains the [[Artist Annotation]] and [[Release Annotation]].
 
 
 
;[[How Voting Works]]
 
:Also quite rudimentary. It explains the decision mechanism of the [[ModBot]].
 
 
 
;[[Editor Privacy]]
 
:Privacy implications of being a [[MusicBrainz]] editor.
 
 
 
;[[Text Search Syntax]]
 
:How to use the powerful text search features in [[MusicBrainz]]
 
 
 
;[[Flickr Machine Tag]]
 
:How to use flickr tags to refer to [[MusicBrainz]] artists, releases, tracks or labels.
 
 
 
==Developer Documentation==
 
 
 
===Metadata===
 
 
 
;[[MusicBrainz_XML_Meta_Data]]
 
:Describes the MusicBrainz XML Metadata Format
 
 
 
===Software===
 
 
 
;[[Client HOWTO]]  
 
:Describes the use of [[libmusicbrainz]], and the [[Client Examples]] programs.
 
 
 
===Discs===
 
 
 
;[[Disc Submission]]
 
:An overview of the highly technical content of [[Disc ID Calculation]].
 
 
 
===Tagging===
 
 
 
;[[ID3v2.4.0]]
 
:Useful links for people wanting to use ID3v2 tags in applications.
 
 
 
;[[ID3v2 Tags]]
 
:A list of some TXXX tags for ID3v2 to toss about and try to "standardize".
 
 
 
;[[Disc IDs and Tagging]]
 
:A short exposé on various tagging standards and their handling of [[Disc ID|DiscID]]s.
 
 
 
;[[MusicBrainz Tag]]
 
:Standardization for [[MusicBrainz]]-specific tags.
 
 
 
;[[MusicBrainz Identifier]]
 
:As used in standardized [[MusicBrainz Tag|MusicBrainzTag]]s.
 
 
 
===Database===
 
 
 
;[[MusicBrainz Database]]
 
:Start page for documentation about the database.
 
 
 
;[[Panther DB Installation]]
 
:Steps to intall PostgreSQL and import [[MusicBrainz]] data on Mac OS X 10.3 aka Panther.
 
 
 
;[[Debian VMWare Database]]
 
:HOWTO install the database under Debian running under VMWare.
 
 
 
==Other Documentation==
 
 
 
* [http://solution.itagent.ne.jp/sw/voca10.html Japanese documentation for MusicBrainz Metadata Initiative 2.1]
 
* [[Other Databases]] -- Other music databases which we might try to work with
 
* [[Links To Free Creative Commons License Music]]
 
* [[MusicBrainz Summit]]s
 
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Latest revision as of 22:43, 6 July 2011

Client libraries

python-musicbrainz2
An outdated client library written in Python which provides easy object oriented access to the MusicBrainz database using the XML web service version 1. (for version 2, it is recommended you use the XML directly until an updated library is completed)
libdiscid
A C library for creating MusicBrainz disc IDs from audio CDs.
See also: Disc ID Calculation.
libmusicbrainz
A C development library geared towards developers who wish to add MusicBrainz lookup capabilities to their applications.

Developer documentation

XML web service
The REST-based webservice API for direct access to MusicBrainz data (Please review the libraries above before writing your own implementation).
See also: Examples
Search query/XML information and Text Search Syntax
RelaxNG schema
Release Editor Seeding: Providing programmatic information to the release editor (from another site or an application), the closest we have to an edit API as yet
(internal) JS autocomplete API
Server setup
The MusicBrainz Server is not available as an executable application. Setting up the server will require you to checkout the source code and follow the INSTALL file's instructions.
The MusicBrainz Database contains all the metadata information available on musicbrainz.org and anyone is free to download and make use of it (and we encourage this!). Setting it up will require access to a PostgreSQL database. See instructions as part of the Server Setup above or use mbslave.
Server environment variables that may prove useful
Search Server Setup if you're brave enough to want to try.
Some javascript testing information
Embedded metadata
Picard Tag Mapping: The documentation for how Picard maps concepts to tags; useful if you want to use these tags elsewhere, or if you'd like to follow the same standard.
See also: ID3v2.4.0
Disc IDs and Tagging
MusicBrainz Identifier
Picard Development
Plugin API Documentation
Picard Tag Mapping
Communicating with other developers
IRC: Here's where you ask questions of real live people, if anyone's awake. You love it, you know it.
Mailing Lists: And here's where you ask if we aren't awake, or for anything style-related or needing more consideration than can be easily given in IRC.
MusicBrainz Summits: These happen occasionally, and people get together and talk about MusicBrainz. You should consider coming! Even if not, the discussions had here are sometimes important, and might be worth perusing.