django-plexauth 0.1.1

A django auth backend for authenticating against plex.tv

***************
django-plexauth
***************



.. image:: https://cloud.githubusercontent.com/assets/203583/7464347/62ecff22-f2ba-11e4-9146-bbd237b2fb93.png
:alt: Screenshot
:align: center


This module provides a django authentication backend for authenticating against plex.tv.

After properly setting up, you should be able to authenticate at /auth/login.

==========
Installing
==========

The quickest way to get installed is through PyPi. Simply run:

.. code-block:: bash

$ pip install django-plexauth

Install by placing the plexauth module in your python path.

All requirements can be installed via pip:

.. code-block:: bash

$ pip install django django-bootstrap3 django-activelink requests


============
Requirements
============
* requests_ >= 2.7.0
* django_ >= 1.8.0
* django-bootstrap3_
* django-activelink_ >= 0.4

=============
Configuration
=============

In the settings.py file for your project, ensure you have the following:

.. code:: python

INSTALLED_APPS = (
...
'bootstrap3',
'activelink',
'plexauth',
)
AUTHENTICATION_BACKENDS = (
'plexauth.auth.PlexBackend',
)

AUTH_USER_MODEL = 'plexauth.PlexUser'
PLEX_ADMIN_USERS = ('admin_usernames')
PLEX_SERVER_NAME = 'your_server_nickname'

In your urls.py file, add the following line

.. code:: python

urlpatterns = patterns('',
...
url(r'^auth/?', include('plexauth.urls')),
)



.. _requests: https://github.com/kennethreitz/requests
.. _django: https://github.com/django/django
.. _django-bootstrap3: https://github.com/dyve/django-bootstrap3
.. _django-activelink