Merge branch 'master' into oauth-login

Author: stefankoegl

.gitignore

@@ -1,5 +1,5 @@
 *.pyc
-htdocs/media/logo/*
+media/*
 logs/*
 *.mo
 mygpo/settings_prod.py
@@ -23,3 +23,9 @@ venv*
 
 # envdirs
 envs
+
+# Jupyter Notebooks
+notebooks/
+
+.cache
+.pytest_cache

.travis.yml

@@ -1,7 +1,6 @@
 language: python
 
 python:
- - "3.5"
  - "3.6"
  - "3.6-dev"
  - "3.7-dev"
@@ -19,7 +18,7 @@ before_script:
   - psql -c 'create database mygpo_test;' -U postgres
 
 script:
-  coverage run --branch --source=mygpo ./manage.py test
+  - pytest --cov=mygpo/ --cov-branch
 
 after_script:
   - coveralls
@@ -28,3 +27,11 @@ env:
  - DATABASE_URL="postgres://postgres@localhost/mygpo_test"
 
 sudo: false
+
+# temporarily allow failures on 3.7
+# see https://github.com/chtd/psycopg2cffi/issues/95
+matrix:
+  allow_failures:
+    - python: "3.7-dev"
+    - python: "nightly"
+

Procfile

@@ -1,2 +1,3 @@
-web: gunicorn mygpo.wsgi:application -c gunicorn.conf.py
-beat: python manage.py celery beat -S django --pidfile /var/run/mygpo/celerybeat.pid
+web: gunicorn mygpo.wsgi:application -c conf/gunicorn.conf.py
+beat: celery -A mygpo beat --pidfile /tmp/celerybeat.pid -S django
+celery: celery -A mygpo worker --concurrency=3 -l info -Ofair

gunicorn.conf.py conf/gunicorn.conf.pygunicorn.conf.py renamed to conf/gunicorn.conf.py

@@ -0,0 +1,9 @@
+import pytest
+
+
+@pytest.fixture(autouse=True)
+def enable_db_access_for_all_tests(db):
+    """ Enable DB access for all tests
+
+    http://pytest-django.readthedocs.io/en/latest/faq.html#how-can-i-give-database-access-to-all-my-tests-without-the-django-db-marker """
+    pass

conftest.py

@@ -40,7 +40,7 @@ Update Device Data
 List Devices
 ------------
 
-..  http:post:: /api/2/devices/(username).json
+..  http:get:: /api/2/devices/(username).json
     :synopsis: list the user's devices
 
     * Requires HTTP authentication

doc/api/reference/devices.rst

@@ -95,3 +95,8 @@ Social Login
 
 * ``GOOGLE_CLIENT_ID`` - Google Client ID
 * ``GOOGLE_CLIENT_SECRET`` - Google Client Secret
+
+
+API
+---
+* ``MAX_EPISODE_ACTIONS`` - maximum number of episode actions that the API will return in one `GET` request.

doc/dev/configuration.rst

@@ -7,7 +7,7 @@ gpodder.net
 The sourcecode of the webservice gpodder.net is released as open source under
 the `AGPLv3 <http://www.gnu.org/licenses/agpl-3.0.html>`_ and `hosted at GitHub
 <https://github.com/gpodder/mygpo>`_. Bugs can be reported at the `gPodder
-Bugtracker <https://bugs.gpodder.org/enter_bug.cgi?product=gpodder.net>`_.
+Bugtracker <https://github.com/gpodder/mygpo/issues>`_.
 
 Integrating Clients
 -------------------
@@ -30,3 +30,4 @@ Contents
     postgres-setup
     libraries
     configuration
+    jupyter-notebook

doc/dev/index.rst

@@ -43,20 +43,7 @@ Now install additional dependencies locally:
     pip install -r requirements-test.txt   # for running tests
 
 
-That's it for the setup. Now to initialize the DB:
-
-First run the commands from :ref:`db-setup`. Then
-
-.. code-block:: bash
-
-    cd mygpo
-    python manage.py migrate
-
-..and here we go:
-
-.. code-block:: bash
-
-    python manage.py runserver
+That's it for the setup.
 
 
 Configuration
@@ -72,9 +59,35 @@ For a development configuration you will probably want to use the following
     echo postgres://mygpo:mygpo@localhost/mygpo > envs/local/DATABASE_URL
     echo True > envs/local/DEBUG
 
+On an Debian/Ubuntu based system, you can perform this configuration with
+
+.. code-block:: bash
+
+    make dev-config
+
 See :ref:`configuration` for further information.
 
 
+Database Initialization
+-----------------------
+
+Now to initialize the DB:
+
+First run the commands from :ref:`db-setup`. Then
+
+.. code-block:: bash
+
+    cd mygpo
+    envdir envs/local python manage.py migrate
+
+..and here we go:
+
+.. code-block:: bash
+
+    envdir envs/local python manage.py runserver
+
+
+
 Accessing the dev server from other devices
 -------------------------------------------
 
@@ -84,7 +97,7 @@ runserver command of manage.py, like this:
 
 .. code-block:: bash
 
-    python manage.py runserver 0.0.0.0:8000
+    envdir envs/local python manage.py runserver 0.0.0.0:8000
 
 Beware, though, that this will expose the web service to your all networks
 that your machine is connected to. Apply common sense and ideally use only
@@ -101,22 +114,22 @@ commands regularly on your development machine:
 
 .. code-block:: bash
 
-    python manage.py update-categories
-    python manage.py update-toplist
-    python manage.py update-episode-toplist
+    envdir envs/local python manage.py update-categories
+    envdir envs/local python manage.py update-toplist
+    envdir envs/local python manage.py update-episode-toplist
 
-    python manage.py feed-downloader
-    python manage.py feed-downloader <feed-url> [...]
-    python manage.py feed-downloader --max <max-updates>
-    python manage.py feed-downloader --random --max <max-updates>
-    python manage.py feed-downloader --toplist --max <max-updates>
-    python manage.py feed-downloader --update-new --max <max-updates>
+    envdir envs/local python manage.py feed-downloader
+    envdir envs/local python manage.py feed-downloader <feed-url> [...]
+    envdir envs/local python manage.py feed-downloader --max <max-updates>
+    envdir envs/local python manage.py feed-downloader --random --max <max-updates>
+    envdir envs/local python manage.py feed-downloader --toplist --max <max-updates>
+    envdir envs/local python manage.py feed-downloader --update-new --max <max-updates>
 
 or to only do a dry run (this won't do any web requests for feeds):
 
 .. code-block:: bash
 
-    python manage.py feed-downloader --list-only [other parameters]
+    envdir envs/local python manage.py feed-downloader --list-only [other parameters]
 
 
 Maintaining publisher relationships with user accounts
@@ -127,7 +140,7 @@ To set a user as publisher for a given feed URL, use:
 .. code-block:: bash
 
     cd mygpo
-    python manage.py make-publisher <username> <feed-url> [...]
+    envdir envs/local python manage.py make-publisher <username> <feed-url> [...]
 
 
 Web-Server
@@ -138,7 +151,7 @@ directory with
 
 .. code-block:: bash
 
-    python manage.py runserver
+    envdir envs/local python manage.py runserver
 
 If you want to run a production server, check out `Deploying Django
 <https://docs.djangoproject.com/en/dev/howto/deployment/>`_.

doc/dev/installation.rst

@@ -0,0 +1,28 @@
+.. _jupyter-notebook:
+
+Jupyter Notebook
+================
+
+You can use `Jupyter Notebooks <http://jupyter.org/>`_ during development for
+exploring data and prototyping methods.
+
+To do so, follow these steps
+
+* Make sure you have all requirements from ``requirements-dev.txt`` installed.
+
+* Run ``make notebook``, which will start the notebook and open it in the
+  browser .
+
+* Navigate to the directory ``notebooks`` (listed in `.gitignore`) and create
+  a new notebook.
+
+* Use the following code in the first cell to setup your environment
+
+  .. code-block:: python
+
+     MYPROJECT = '/path/to/mygpo'
+     import os, sys
+     sys.path.insert(0, MYPROJECT)
+     os.environ.setdefault("DJANGO_SETTINGS_MODULE", "local_settings.py")
+     import django
+     django.setup()