flask-cas-ng/setup.py
2019-03-26 17:27:08 -04:00

94 lines
2.8 KiB
Python

#!/usr/bin/env python2
#Copyright (C) 2014, Cameron Brandon White
# -*- coding: utf-8 -*-
import setuptools
import textwrap
if __name__ == "__main__":
setuptools.setup(
name="flask-cas-ng",
version="1.1.0",
description="Flask extension for CAS",
author="Cameron Brandon White",
author_email="cameronbwhite90@gmail.com",
url="https://github.com/MasterRoshan/flask-cas-ng",
long_description=textwrap.dedent("""\
flask-cas-ng
=========
flask-cas-ng is a maintenance fork of the original Flask-CAS
flask-cas-ng is a Flask extension which makes it easy to
authenticate with a CAS.
CAS
===
The Central Authentication Service (CAS) is a single sign-on
protocol for the web. Its purpose is to permit a user to access
multiple applications while providing their credentials (such as
userid and password) only once. It also allows web applications
to authenticate users without gaining access to a user's security
credentials, such as a password. The name CAS also refers to a
software package that implements this protocol.
(Very short) Setup Tutorial
===========================
First create a Flask instance:
.. code:: python
from flask import Flask
app = Flask(__name__)
Apply CAS on your Flask instance:
.. code:: python
from flask_cas import CAS
CAS(app)
Do needed configuration:
.. code:: python
app.config['CAS_SERVER'] = 'https://sso.pdx.edu'
app.config['CAS_AFTER_LOGIN'] = 'route_root'
Using
=====
After you setup you will get two new routes `/login/`
and `/logout/`.
Reference documentation
=======================
See https://github.com/MasterRoshan/flask-cas-ng"""),
packages=[
"flask_cas",
],
install_requires = [
"Flask",
"xmltodict",
],
test_requires = [
"Nose",
"Mock",
],
test_suite = "nose.collector",
include_package_data=True,
classifiers=[
'Environment :: Web Environment',
'Intended Audience :: Developers',
'License :: OSI Approved :: BSD License',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
'Topic :: Software Development :: Libraries :: Python Modules'
],
zip_safe=False,
)