Server for the ListenBrainz project
Clone or download
paramsingh Merge pull request #429 from paramsingh/update-sequences
Update sequences after data import into postgres
Latest commit 785a552 Sep 5, 2018
Permalink
Failed to load latest commit information.
.github Add sample JIRA ticket number to PULL_REQUEST_TEMPLATE Dec 18, 2017
admin Update schema version and add index to schema update script. Jun 25, 2018
docker Use web image and add volume for spotify_reader Jun 25, 2018
docs LB-333: Fix build issue with docs, fix other warnings Jun 20, 2018
listenbrainz Update sequences after data import into postgres Sep 5, 2018
.dockerignore Move from filesystem paths to named volumes. Hopefully this will remo… Mar 15, 2018
.gitignore Use BrainzUtils CustomFlask instead of Flask Nov 12, 2017
.travis.yml Use test_config.py instead of rtd_config.py on travis Jun 21, 2018
Dockerfile Add script to backup ListenBrainz dumps Feb 14, 2018
Dockerfile.nginx.prod Finished implementing the nginx front end for the proxy Sep 8, 2017
Dockerfile.prod Fix less version to stop bug in newer versions Jun 19, 2018
HACKING.md Add License notice and do some other doc updates Jun 24, 2017
LICENSE Re-adding the LICENSE and README files Sep 5, 2015
README.md Add unit tests to devel env; remove duplicated content from README Nov 12, 2017
bigquery-credentials.json.ctmpl Change quotes, change life -> existentialist crisis! Mar 12, 2017
consul_config.py.ctmpl Fix error referencing MeB.org in consul_config.py.ctmpl Jul 13, 2018
develop.sh Move prod files to non-prod files, since prod is not used in actual p… Feb 18, 2017
import_musicbrainz_row_ids.py Add an independent switch for deleting users Jun 21, 2018
integration-test.sh Use python3 in integration-test.sh and test.sh Jun 1, 2017
manage.py More cleanup and also making sure the config file exists before Mar 16, 2018
pytest.ini Add listenbrainz/domain to pytest.ini Jun 25, 2018
requirements.txt Add an admin view to monitor users and spotify imports Jun 25, 2018
test.sh Accept parameters after test.sh to test specific module Mar 19, 2018

README.md

listenbrainz-server

Server for the ListenBrainz project

Website | Documentation | Bug tracker

About

The ListenBrainz project is similar to the original AudioScrobbler®. Unlike the original project, ListenBrainz is open source and publishes its data as open data.

A team of former Last.fm and current MusicBrainz hackers created the first version of ListenBrainz in a weekend. Since the original project was created, technology has advanced at an incredibly rapid pace, which made re-creating the original project fairly straightforward.

The project has two main goals:

  1. Allow users to preserve their existing Last.fm® data
  2. Make this incredibly useful music usage data available to the world

For more information about this project and its goals, look at our website, specifically the goals page.

Development environment

These instructions help you get started with the development process. Installation in a production environment may be different.

Read the development environment documentation

Calculating statistics

ListenBrainz uses Google BigQuery to calculate statistics. You need a BigQuery credentials file called bigquery-credentials.json to the credentials directory for it to work. This file is obtained from the Google BigQuery site by creating a new project. The WRITE_TO_BIGQUERY variable in config.py needs to be set to True also.

The stats are automatically calculated in the scheduler container, but if you want to manually start statistic calculation, run this.

docker-compose -f docker/docker-compose.yml -p listenbrainz run --rm web python manage.py stats calculate

Documentation

Full documentation for the ListenBrainz API is available at listenbrainz.readthedocs.org. You can also build the documentation locally:

cd listenbrainz-server/docs
make clean html

License Notice

listenbrainz-server - Server for the ListenBrainz project

Copyright (C) 2017 MetaBrainz Foundation Inc.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA