CritiqueBrainz — CritiqueBrainz 0.1 documentation

<!DOCTYPE html>   <html class="no-js" lang="en" >  <head> <meta charset="utf-8"> <meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>CritiqueBrainz — CritiqueBrainz 0.1 documentation</title> <script type="text/javascript" src="_static/js/modernizr.min.js"></script> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/jquery.js"></script> <script src="_static/underscore.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> <script type="text/javascript" src="_static/js/theme.js"></script> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Introduction" href="intro.html" />  <script type="application/json" id="READTHEDOCS_DATA">{"ad_free": false, "api_host": "https://readthedocs.org", "build_date": "2022-08-30T17:24:46Z", "builder": "sphinx", "canonical_url": null, "commit": "cba75237", "docroot": "/docs/", "features": {"docsearch_disabled": false}, "global_analytics_code": null, "language": "en", "page": "index", "programming_language": "py", "project": "critiquebrainz", "proxied_api_host": "/_", "source_suffix": ".rst", "subprojects": {}, "theme": "sphinx_rtd_theme", "user_analytics_code": "", "version": "latest"}</script>  <script type="text/javascript"> READTHEDOCS_DATA = JSON.parse(document.getElementById('READTHEDOCS_DATA').innerHTML); </script>  <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="critiquebrainz" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="#" class="icon icon-home"> CritiqueBrainz </a> <div class="version"> latest </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <ul> <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li> <li class="toctree-l1"><a class="reference internal" href="api.html">API</a></li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> <li class="toctree-l1"><a class="reference internal" href="db.html">Database</a></li> <li class="toctree-l1"><a class="reference internal" href="export.html">Exporting data</a></li> <li class="toctree-l1"><a class="reference internal" href="translation.html">Translation</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="#">CritiqueBrainz</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="#">Docs</a> »</li> <li>CritiqueBrainz</li> <li class="wy-breadcrumbs-aside"> <a href="https://github.com/metabrainz/critiquebrainz/blob/master/docs/index.rst" class="fa fa-github"> Edit on GitHub</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="critiquebrainz"> <h1>CritiqueBrainz<a class="headerlink" href="#critiquebrainz" title="Permalink to this heading">露</a></h1> <p>Hello there! Thanks for your interest in CritiqueBrainz project. It is a repository for Creative Commons licensed reviews for music, books and other things. This project is based on data from MusicBrainz - open music encyclopedia, and BookBrainz - open book encyclopedia. Everyone - including you - can participate and contribute.</p> <p>This is an open source project. Source code is available <a class="reference external" href="https://github.com/metabrainz/critiquebrainz">on GitHub</a>.</p> <section id="contents"> <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this heading">露</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a><ul> <li class="toctree-l2"><a class="reference internal" href="intro.html#setting-up-the-server">Setting up the server</a></li> <li class="toctree-l2"><a class="reference internal" href="intro.html#testing">Testing</a></li> <li class="toctree-l2"><a class="reference internal" href="intro.html#modifying-strings">Modifying strings</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api.html">API</a><ul> <li class="toctree-l2"><a class="reference internal" href="api/endpoints.html">Endpoint reference</a></li> <li class="toctree-l2"><a class="reference internal" href="api/oauth2.html">OAuth 2.0</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a><ul> <li class="toctree-l2"><a class="reference internal" href="contributing.html#structure">Structure</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="db.html">Database</a><ul> <li class="toctree-l2"><a class="reference internal" href="db.html#entities">Entities</a></li> <li class="toctree-l2"><a class="reference internal" href="db.html#schema-diagram">Schema diagram</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="export.html">Exporting data</a><ul> <li class="toctree-l2"><a class="reference internal" href="export.html#creating-data-dumps">Creating data dumps</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="translation.html">Translation</a><ul> <li class="toctree-l2"><a class="reference internal" href="translation.html#extracting-strings">Extracting strings</a></li> <li class="toctree-l2"><a class="reference internal" href="translation.html#adding-support-for-a-new-language">Adding support for a new language</a></li> <li class="toctree-l2"><a class="reference internal" href="translation.html#additional-info">Additional info</a></li> </ul> </li> </ul> </div> </section> </section> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="intro.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> </div> <hr/> <div role="contentinfo"> <p> <span class="commit"> Revision <code>cba75237</code>. </span> </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>

CINXE.COM

CritiqueBrainz — CritiqueBrainz 0.1 documentation