Commit 6981433b authored by Valentin Samir's avatar Valentin Samir

Licence, readme and cie

parent c16bb2d7
This diff is collapsed.
include LICENSE
include README.rst
recursive-include cas_server/templates/*
recursive-include cas_server/locale/*
recursive-include cas_server/static/*
=====
CAS Server
=====
CAS Server is a Django app implementing the CAS Protocol 3.0 Specification
(https://jasig.github.io/cas/development/protocol/CAS-Protocol-Specification.html)
By defaut, the authentication process use django internal users but you can easily
use any sources (see auth classes in the auth.py file)
The differents parametters you can use in settings.py to tweak the application
are listed in default_settings.py
The defaut login/logout template use django-bootstrap3 (https://github.com/dyve/django-bootstrap3)
but you can use your own templates using the CAS_LOGIN_TEMPLATE,
CAS_LOGGED_TEMPLATE and CAS_WARN_TEMPLATE.
Quick start
-----------
1. Add "cas_server" to your INSTALLED_APPS setting like this::
INSTALLED_APPS = (
...
'cas_server',
)
2. Include the polls URLconf in your project urls.py like this::
url(r'^cas/', include('cas_server.urls')),
3. Run `python manage.py migrate` to create the cas_server models.
4. Start the development server and visit http://127.0.0.1:8000/admin/
to add a first service allowed to authenticate user agains the CAS
(you'll need the Admin app enabled).
5. Visit http://127.0.0.1:8000/cas/ to login with your django users.
import os
from setuptools import setup
with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
README = readme.read()
# allow setup.py to be run from any path
os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
setup(
name='django-cas-server',
version='0.1',
packages=['cas_server'],
include_package_data=True,
license='GPLv3',
description='A Django app implementing the CAS Protocol 3.0 Specification',
long_description=README,
author='Valentin Samir',
author_email='valentin.samir@crans.org',
classifiers=[
'Environment :: Web Environment',
'Framework :: Django',
'Intended Audience :: Developers',
'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
'Operating System :: OS Independent',
'Programming Language :: Python',
# Replace these appropriately if you are stuck on Python 2.
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.7',
'Topic :: Internet :: WWW/HTTP',
'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
],
)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment