Initial commit

.coveragerc

+[run]
+include = funkwhale_api/*
+omit = *migrations*, *tests*
+plugins =
+    django_coverage_plugin

.editorconfig

+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+
+[*.py]
+line_length=120
+known_first_party=funkwhale_api
+multi_line_output=3
+default_section=THIRDPARTY
+
+[*.{html,css,scss,json,yml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

.gitattributes

+* text=auto

.gitignore

+### OSX ###
+.DS_Store
+.AppleDouble
+.LSOverride
+
+### SublimeText ###
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+# Basics
+*.py[cod]
+__pycache__
+
+# Logs
+*.log
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+nosetests.xml
+htmlcov
+
+# Translations
+*.mo
+*.pot
+
+# Pycharm
+.idea
+
+# Vim
+
+*~
+*.swp
+*.swo
+
+# npm
+node_modules/
+
+# Compass
+.sass-cache
+
+# virtual environments
+.env
+
+# User-uploaded media
+funkwhale_api/media/
+
+# Hitch directory
+tests/.hitch
+
+# MailHog binary
+mailhog

.pylintrc

+[MASTER]
+load-plugins=pylint_common, pylint_django, pylint_celery 
+
+[FORMAT]
+max-line-length=120
+
+[MESSAGES CONTROL]
+disable=missing-docstring,invalid-name
+
+[DESIGN]
+max-parents=13
\ No newline at end of file

.travis.yml

+sudo: true
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -qq build-essential gettext python-dev zlib1g-dev libpq-dev xvfb
+  - sudo apt-get install -qq libtiff4-dev libjpeg8-dev libfreetype6-dev liblcms1-dev libwebp-dev
+  - sudo apt-get install -qq graphviz-dev python-setuptools python3-dev python-virtualenv python-pip
+  - sudo apt-get install -qq firefox automake libtool libreadline6 libreadline6-dev libreadline-dev
+  - sudo apt-get install -qq libsqlite3-dev libxml2 libxml2-dev libssl-dev libbz2-dev wget curl llvm
+language: python
+python:
+- "3.5"
+
+install:
+  - "pip install hitch"
+  - "cd tests"
+  - "hitch init"
+script:
+  - "hitch test . --extra '{\"xvfb\":true, \"pause_on_failure\":false}'"

CONTRIBUTORS.txt

+Eliot Berriot

Dockerfile

+FROM python:3.5
+
+ENV PYTHONUNBUFFERED 1
+
+# Requirements have to be pulled and installed here, otherwise caching won't work
+COPY ./requirements /requirements
+
+RUN pip install -r /requirements/production.txt
+
+RUN groupadd -r django && useradd -r -g django django
+COPY . /app
+RUN chown -R django /app
+
+COPY ./compose/django/gunicorn.sh /gunicorn.sh
+COPY ./compose/django/entrypoint.sh /entrypoint.sh
+
+RUN chmod +x /entrypoint.sh && chown django /entrypoint.sh
+RUN chmod +x /gunicorn.sh && chown django /gunicorn.sh
+
+WORKDIR /app
+
+ENTRYPOINT ["/entrypoint.sh"]

Dockerfile-dev

+FROM python:3.5
+
+ENV PYTHONUNBUFFERED 1
+
+# Requirements have to be pulled and installed here, otherwise caching won't work
+COPY ./requirements /requirements
+RUN pip install -r /requirements/local.txt
+
+COPY ./compose/django/entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+
+WORKDIR /app
+
+ENTRYPOINT ["/entrypoint.sh"]

Gruntfile.js

+module.exports = function (grunt) {
+
+  var appConfig = grunt.file.readJSON('package.json');
+
+  // Load grunt tasks automatically
+  // see: https://github.com/sindresorhus/load-grunt-tasks
+  require('load-grunt-tasks')(grunt);
+
+  // Time how long tasks take. Can help when optimizing build times
+  // see: https://npmjs.org/package/time-grunt
+  require('time-grunt')(grunt);
+
+  var pathsConfig = function (appName) {
+    this.app = appName || appConfig.name;
+
+    return {
+      app: this.app,
+      templates: this.app + '/templates',
+      css: this.app + '/static/css',
+      sass: this.app + '/static/sass',
+      fonts: this.app + '/static/fonts',
+      images: this.app + '/static/images',
+      js: this.app + '/static/js',
+      manageScript: 'manage.py',
+    }
+  };
+
+  grunt.initConfig({
+
+    paths: pathsConfig(),
+    pkg: appConfig,
+
+    // see: https://github.com/gruntjs/grunt-contrib-watch
+    watch: {
+      gruntfile: {
+        files: ['Gruntfile.js']
+      },
+      sass: {
+        files: ['<%= paths.sass %>/**/*.{scss,sass}'],
+        tasks: ['sass:dev'],
+        options: {
+          atBegin: true
+        }
+      },
+      livereload: {
+        files: [
+          '<%= paths.js %>/**/*.js',
+          '<%= paths.sass %>/**/*.{scss,sass}',
+          '<%= paths.app %>/**/*.html'
+          ],
+        options: {
+          spawn: false,
+          livereload: true,
+        },
+      },
+    },
+
+    // see: https://github.com/sindresorhus/grunt-sass
+    sass: {
+      dev: {
+          options: {
+              outputStyle: 'nested',
+              sourceMap: false,
+              precision: 10
+          },
+          files: {
+              '<%= paths.css %>/project.css': '<%= paths.sass %>/project.scss'
+          },
+      },
+      dist: {
+          options: {
+              outputStyle: 'compressed',
+              sourceMap: false,
+              precision: 10
+          },
+          files: {
+              '<%= paths.css %>/project.css': '<%= paths.sass %>/project.scss'
+          },
+      }
+    },
+
+    //see https://github.com/nDmitry/grunt-postcss
+    postcss: {
+      options: {
+        map: true, // inline sourcemaps
+
+        processors: [
+          require('pixrem')(), // add fallbacks for rem units
+          require('autoprefixer-core')({browsers: [
+            'Android 2.3',
+            'Android >= 4',
+            'Chrome >= 20',
+            'Firefox >= 24',
+            'Explorer >= 8',
+            'iOS >= 6',
+            'Opera >= 12',
+            'Safari >= 6'
+          ]}), // add vendor prefixes
+          require('cssnano')() // minify the result
+        ]
+      },
+      dist: {
+        src: '<%= paths.css %>/*.css'
+      }
+    },
+
+    // see: https://npmjs.org/package/grunt-bg-shell
+    bgShell: {
+      _defaults: {
+        bg: true
+      },
+      runDjango: {
+        cmd: 'python <%= paths.manageScript %> runserver'
+      },
+      
+    }
+  });
+
+  grunt.registerTask('serve', [
+    
+    'bgShell:runDjango',
+    'watch'
+  ]);
+
+  grunt.registerTask('build', [
+    'sass:dist',
+    'postcss'
+  ]);
+
+  grunt.registerTask('default', [
+    'build'
+  ]);
+
+};

LICENSE

+Copyright (c) 2015, Eliot Berriot
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+
+* Neither the name of funkwhale_api nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.

Procfile

+web: gunicorn config.wsgi:application

README.rst

+funkwhale_api
+==============================
+
+A self-hosted tribute to Grooveshark.com
+
+
+LICENSE: BSD
+
+Settings
+------------
+
+Moved to settings_.
+
+.. _settings: http://cookiecutter-django.readthedocs.org/en/latest/settings.html
+
+Basic Commands
+--------------
+
+Setting Up Your Users
+^^^^^^^^^^^^^^^^^^^^^
+
+To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
+
+To create an **superuser account**, use this command::
+
+    $ python manage.py createsuperuser
+
+For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.
+
+Test coverage
+^^^^^^^^^^^^^
+
+To run the tests, check your test coverage, and generate an HTML coverage report::
+
+    $ coverage run manage.py test
+    $ coverage html
+    $ open htmlcov/index.html
+
+Live reloading and Sass CSS compilation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Moved to `Live reloading and SASS compilation`_.
+
+.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.org/en/latest/live-reloading-and-sass-compilation.html
+
+
+
+Celery
+^^^^^^
+
+This app comes with Celery.
+
+To run a celery worker:
+
+.. code-block:: bash
+
+    cd funkwhale_api
+    celery -A funkwhale_api.taskapp worker -l info
+
+Please note: For Celerys import magic to work, it is important *where* the celery commands are run. If you are in the same folder with *manage.py*, you should be right.
+
+
+
+
+
+
+
+It's time to write the code!!!
+
+
+Running end to end integration tests
+------------------------------------
+
+N.B. The integration tests will not run on Windows.
+
+To install the test runner::
+
+  $ pip install hitch
+
+To run the tests, enter the funkwhale_api/tests directory and run the following commands::
+
+  $ hitch init
+
+Then run the stub test::
+
+  $ hitch test stub.test
+
+This will download and compile python, postgres and redis and install all python requirements so the first time it runs it may take a while.
+
+Subsequent test runs will be much quicker.
+
+The testing framework runs Django, Celery (if enabled), Postgres, HitchSMTP (a mock SMTP server), Firefox/Selenium and Redis.
+
+
+Deployment
+----------
+
+We providing tools and instructions for deploying using Docker and Heroku.
+
+Heroku
+^^^^^^
+
+.. image:: https://www.herokucdn.com/deploy/button.png
+    :target: https://heroku.com/deploy
+
+See detailed `cookiecutter-django Heroku documentation`_.
+
+.. _`cookiecutter-django Heroku documentation`: http://cookiecutter-django.readthedocs.org/en/latest/deployment-on-heroku.html
+
+Docker
+^^^^^^
+
+See detailed `cookiecutter-django Docker documentation`_.
+
+.. _`cookiecutter-django Docker documentation`: http://cookiecutter-django.readthedocs.org/en/latest/deployment-with-docker.html

app.json

+{
+  "name": "funkwhale_api",
+  "description": "A self-hosted tribute to Grooveshark.com",
+  "env": {
+    "BUILDPACK_URL": "https://github.com/heroku/heroku-buildpack-python",
+    "DJANGO_SETTINGS_MODULE": "config.settings.production",
+    "DJANGO_SECRET_KEY": {
+      "description": "A secret key for verifying the integrity of signed cookies.",
+      "generator": "secret"
+    },
+    "DJANGO_ALLOWED_HOSTS": {
+      "description": "Comma-separated list of hosts",
+      "value": ".herokuapp.com"
+    },
+    "DJANGO_ADMIN_URL": {
+      "description": "A secret URL for the Django admin",
+      "generator": "secret"
+    },
+    "DJANGO_AWS_ACCESS_KEY_ID": "",
+    "DJANGO_AWS_SECRET_ACCESS_KEY": "",
+    "DJANGO_AWS_STORAGE_BUCKET_NAME": "",
+    "DJANGO_MAILGUN_SERVER_NAME": "",
+    
+    "DJANGO_MAILGUN_API_KEY": "" 
+  },
+  "scripts": {
+    "postdeploy": "python manage.py migrate"
+  },
+  "addons": [
+    "heroku-postgresql:hobby-dev",
+    "heroku-redis:hobby-dev",
+    "mailgun"
+  ]
+}

compose/django/entrypoint.sh

+#!/bin/bash
+set -e
+# This entrypoint is used to play nicely with the current cookiecutter configuration.
+# Since docker-compose relies heavily on environment variables itself for configuration, we'd have to define multiple
+# environment variables just to support cookiecutter out of the box. That makes no sense, so this little entrypoint
+# does all this for us.
+export REDIS_URL=redis://redis:6379/0
+
+# the official postgres image uses 'postgres' as default user if not set explictly.
+if [ -z "$POSTGRES_ENV_POSTGRES_USER" ]; then
+    export POSTGRES_ENV_POSTGRES_USER=postgres
+fi 
+
+export DATABASE_URL=postgres://$POSTGRES_ENV_POSTGRES_USER:$POSTGRES_ENV_POSTGRES_PASSWORD@postgres:5432/$POSTGRES_ENV_POSTGRES_USER
+
+export CELERY_BROKER_URL=$REDIS_URL
+
+exec "$@"
\ No newline at end of file

compose/django/gunicorn.sh

+#!/bin/sh
+python /app/manage.py collectstatic --noinput
+/usr/local/bin/gunicorn config.wsgi -w 4 -b 0.0.0.0:5000 --chdir=/app
\ No newline at end of file

compose/nginx/Dockerfile

+FROM nginx:latest
+ADD nginx.conf /etc/nginx/nginx.conf
\ No newline at end of file

compose/nginx/nginx.conf

+user  nginx;
+worker_processes  1;
+
+error_log  /var/log/nginx/error.log warn;
+pid        /var/run/nginx.pid;
+
+
+events {
+    worker_connections  1024;
+}
+
+
+http {
+    include       /etc/nginx/mime.types;
+    default_type  application/octet-stream;
+
+    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+
+    access_log  /var/log/nginx/access.log  main;
+
+    sendfile        on;
+    #tcp_nopush     on;
+
+    keepalive_timeout  65;
+
+    #gzip  on;
+
+    upstream app {
+        server django:5000;
+    }
+
+    server {
+        listen 80;
+        charset     utf-8;
+
+
+        location / {
+            # checks for static file, if not found proxy to app
+            try_files $uri @proxy_to_app;
+        }
+
+        location @proxy_to_app {
+            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+            proxy_set_header Host $http_host;
+            proxy_redirect off;
+
+            proxy_pass   http://app;
+        }
+
+    }
+}
\ No newline at end of file

config/settings/__init__.py

+# -*- coding: utf-8 -*-