Update doc

Makefile

@@ -68,9 +68,5 @@ run_tests: test_venv
 test_venv/bin/sphinx-build: test_venv
 	test_venv/bin/pip install Sphinx sphinx_rtd_theme
 
-
-docs/package: test_venv/bin/sphinx-build
-	test_venv/bin/sphinx-apidoc -f -e cas_server -o docs/package/ cas_server/migrations/ cas_server/management/ cas_server/tests/ #cas_server/cas.py
-
-docs: docs/package test_venv/bin/sphinx-build
+docs: test_venv/bin/sphinx-build
 	bash -c "source test_venv/bin/activate; cd docs; make html"

cas_server/federate.py

@@ -37,6 +37,10 @@ class CASFederateValidateUser(object):
     attributs = {}
     #: the CAS client instance
     client = None
+    #: the provider returned username this the provider suffix appended
+    federated_username = None
+    #: the identity provider
+    provider = None
 
     def __init__(self, provider, service_url):
         self.provider = provider

docs/Makefile

@@ -50,7 +50,6 @@ clean:
 
 .PHONY: html
 html:
-	wget https://docs.djangoproject.com/en/1.9/_objects -O django.inv
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

docs/conf.py

@@ -22,7 +22,7 @@ sys.path.insert(0, os.path.abspath('.'))
 sys.path.append(os.path.abspath('..'))
 sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
 
-SETUP = os.path.abspath('../setup.py')
+import setup as mysetup
 
 os.environ['DJANGO_SETTINGS_MODULE'] = 'cas_server.tests.settings'
 
@@ -72,7 +72,7 @@ author = u'Valentin Samir'
 # built documents.
 #
 # The short X.Y version.
-version = os.popen("python %s -V" % SETUP).read().strip().decode("ascii")
+version = mysetup.VERSION
 # The full version, including alpha/beta/rc tags.
 release = version
 
@@ -356,3 +356,14 @@ intersphinx_mapping = {
 autodoc_member_order = 'bysource'
 
 locale_dirs = ['../test_venv/lib/python2.7/site-packages/django/conf/locale/']
+
+
+def _download_django_inv():
+    import requests
+    with open(_download_django_inv.path, 'w') as f:
+        r = requests.get("https://docs.djangoproject.com/en/1.9/_objects")
+        f.write(r.content)
+_download_django_inv.path = os.path.abspath(os.path.join(os.path.dirname(__file__), "django.inv"))
+
+if not os.path.isfile(_download_django_inv.path):
+    _download_django_inv()

setup.py

@@ -2,78 +2,91 @@ import os
 import pkg_resources
 from setuptools import setup
 
+VERSION = '0.6.0'
+
 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)))
+if __name__ == '__main__':
+    # allow setup.py to be run from any path
+    os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir)))
 
 
-# if we have Django 1.8 available, use last version of django-boostrap3
-try:
-    pkg_resources.require('Django >= 1.8')
-    django_bootstrap3 = 'django-bootstrap3 >= 5.4'
-    django = 'Django >= 1.8,<1.10'
-except pkg_resources.VersionConflict:
-    # Else if we have django 1.7, we need django-boostrap3 < 7.0.0
+    # if we have Django 1.8 available, use last version of django-boostrap3
     try:
-        pkg_resources.require('Django >= 1.7')
-        django_bootstrap3 = 'django-bootstrap3 >= 5.4,<7.0.0'
-        django = 'Django >= 1.7,<1.8'
-    except (pkg_resources.VersionConflict, pkg_resources.DistributionNotFound):
-        # Else we need to install Django, assume version will be >= 1.8
+        pkg_resources.require('Django >= 1.8')
+        django_bootstrap3 = 'django-bootstrap3 >= 5.4'
+        django = 'Django >= 1.8,<1.10'
+    except pkg_resources.VersionConflict:
+        # Else if we have django 1.7, we need django-boostrap3 < 7.0.0
+        try:
+            pkg_resources.require('Django >= 1.7')
+            django_bootstrap3 = 'django-bootstrap3 >= 5.4,<7.0.0'
+            django = 'Django >= 1.7,<1.8'
+        except (pkg_resources.VersionConflict, pkg_resources.DistributionNotFound):
+            # Else we need to install Django, assume version will be >= 1.8
+            django_bootstrap3 = 'django-bootstrap3 >= 5.4'
+            django = 'Django >= 1.8,<1.10'
+    # No version of django installed, assume version will be >= 1.8
+    except pkg_resources.DistributionNotFound:
         django_bootstrap3 = 'django-bootstrap3 >= 5.4'
         django = 'Django >= 1.8,<1.10'
-# No version of django installed, assume version will be >= 1.8
-except pkg_resources.DistributionNotFound:
-    django_bootstrap3 = 'django-bootstrap3 >= 5.4'
-    django = 'Django >= 1.8,<1.10'
 
-setup(
-    name='django-cas-server',
-    version='0.6.0',
-    packages=[
-        'cas_server', 'cas_server.migrations',
-        'cas_server.management', 'cas_server.management.commands',
-        'cas_server.tests'
-    ],
-    include_package_data=True,
-    license='GPLv3',
-    description=(
-        'A Django Central Authentication Service server '
-        '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',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 3',
-        'Topic :: Internet :: WWW/HTTP',
-        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
-    ],
-    package_data={
-        'cas_server': [
-            'templates/cas_server/*',
-            'static/cas_server/*',
-            'locale/*/LC_MESSAGES/*',
-        ]
-    },
-    keywords=['django', 'cas', 'cas3', 'server', 'sso', 'single sign-on', 'authentication', 'auth'],
-    install_requires=[
-        django, 'requests >= 2.4', 'requests_futures >= 0.9.5',
-        'django-picklefield >= 0.3.1', django_bootstrap3, 'lxml >= 3.4',
-        'six >= 1'
-    ],
-    url="https://github.com/nitmir/django-cas-server",
-    download_url="https://github.com/nitmir/django-cas-server/releases",
-    zip_safe=False,
-    setup_requires=['pytest-runner'],
-    tests_require=['pytest', 'pytest-django', 'pytest-pythonpath'],
-)
+    setup(
+        name='django-cas-server',
+        version=VERSION,
+        packages=[
+            'cas_server', 'cas_server.migrations',
+            'cas_server.management', 'cas_server.management.commands',
+            'cas_server.tests'
+        ],
+        include_package_data=True,
+        license='GPLv3',
+        description=(
+            'A Django Central Authentication Service server '
+            'implementing the CAS Protocol 3.0 Specification'
+        ),
+        long_description=README,
+        author='Valentin Samir',
+        author_email='valentin.samir@crans.org',
+        classifiers=[
+            'Environment :: Web Environment',
+            'evelopment Status :: 5 - Production/Stable',
+            'Framework :: Django',
+            'Framework :: Django :: 1.7',
+            'Framework :: Django :: 1.8',
+            'Framework :: Django :: 1.9',
+            'Intended Audience :: Developers',
+            'Intended Audience :: System Administrators',
+            'License :: OSI Approved :: GNU General Public License v3 (GPLv3)',
+            'Operating System :: OS Independent',
+            'Programming Language :: Python',
+            'Programming Language :: Python :: 2',
+            'Programming Language :: Python :: 2.7',
+            'Programming Language :: Python :: 3',
+            'Programming Language :: Python :: 3.4',
+            'Programming Language :: Python :: 3.5',
+            'Topic :: Software Development :: Libraries :: Python Modules',
+            'Topic :: Internet :: WWW/HTTP',
+            'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+            'Topic :: System :: Systems Administration :: Authentication/Directory'
+        ],
+        package_data={
+            'cas_server': [
+                'templates/cas_server/*',
+                'static/cas_server/*',
+                'locale/*/LC_MESSAGES/*',
+            ]
+        },
+        keywords=['django', 'cas', 'cas3', 'server', 'sso', 'single sign-on', 'authentication', 'auth'],
+        install_requires=[
+            django, 'requests >= 2.4', 'requests_futures >= 0.9.5',
+            'django-picklefield >= 0.3.1', django_bootstrap3, 'lxml >= 3.4',
+            'six >= 1'
+        ],
+        url="https://github.com/nitmir/django-cas-server",
+        download_url="https://github.com/nitmir/django-cas-server/releases",
+        zip_safe=False,
+        setup_requires=['pytest-runner'],
+        tests_require=['pytest', 'pytest-django', 'pytest-pythonpath'],
+    )