Skip to content

Latest commit

 

History

History
137 lines (95 loc) · 4.59 KB

README.md

File metadata and controls

137 lines (95 loc) · 4.59 KB
Raw

Django Podcast Client

Django Podcast Client implements a simple podcasting client that can be used from both the command line and your browser. If you choose to only use as a command line tool, there is no need to run a Django instance as a service.

Build Status Coverage Status

Setup

Install using pip:

pip install git+https://github.com/jsatt/django-podcast-client.git

Create new django instance (skip this if you already have one):

django-admin.py startproject <project name>
cd <project name>
python manage.py syncdb

run chmod +x manage.py to run as ./manage.py <command> from here on out

Add to installed apps in <project name>/settings.py:

INSTALLED_APPS = (
    ...
    django_extensions,
    south,
    podcast_client
)

Setup the database:

./manage.py migrate podcast_client

Add urls in <project name>/urls.py (skip if only using CLI):

urlpatterns = ('',
...
(r'^podcasts/', include('podcast_client.urls')),
)

Add media files to your local static directory

./manage.py collectstatic

If you would like to use Transmission for downloading torrent files simply add the following setting block to <project name>/settings.py:

TRANSMISSION = {
    'address': '<address to transmission server>',
    'port': '9091',
    'user': '<username>',
    'password': '<password>',
}

Setup Celery

Celery is used to run tasks such as downloading files and checking for updates asynchronously.

You can bypass this functionality by simply adding CELERY_ALWAYS_EAGER = True to your settings.py, but this is not recommended. File downloads often take longer than a normal server timeout, so it is prefered to allow Celery to perform these tasks asynchronously and allow the browser interface to update when the task is complete.

One of the simplest and easiest ways of getting started is using Celery 3.1+ with a Redis backend.

apt-get install redis-server
pip install celery[redis]

Add the following lines to your settings.py

BROKER_URL = 'redis://localhost:6379/0'
CELERY_RESULT_BACKEND = 'redis://localhost:6379/0'

You can now run the follwing command to start the Celery worker.

export DJANGO_SETTINGS_MODULE=<project name>.settings; celery worker -A podcast_client -l info

It is recommended that you setup the Celery worker to run automatically with something like Supervisord or Circus, but that is beyond the scope of this document.

Using in Browser

Start Django server:

./manage.py runserver

There are a slew of other ways to run as a service which I will leave up to you to research. How to deploy with WSGI

Browse to http://<localhost or hostname>:8000/podcasts/.

Using Command-line

TODO

Requirements

TODO

Contibuting

Django expects a few things to be setup for development that you won't have without a project. I've borrowed a pattern used by jsocol which uses Fabric.

Be sure to install Fabric using pip install fabric, and use fab to run your developement environment. Run fab -l to see all options.

Running tests also requires nose and mox. Run pip install mox nose django-nose to install. You can then run fab test.

To manually run the app, you'll want to run fab syncdb then fab migrate, then you can run fab serve to start the Django dev server, or fab shell to open the Django shell.

Please make sure any pull requests are PEP8 compliant, pass pyflakes, and have complete test coverage. It's also preferable that an issue is opened and discussed before a pull request is merged.

License

Django Podcast Client Copyright (C) 2016 Jeremy Satterfield

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 3 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, see http://www.gnu.org/licenses/.