Python CAS

.. image:: https://github.com/python-cas/python-cas/actions/workflows/CI.yml/badge.svg :target: https://github.com/python-cas/python-cas/actions/workflows/CI.yml

Python CAS implements CAS protocol (Central Authentication Service) client.

This project was started by refactoring out CASClient classes from the django-cas-ng_ project.

Now CASClient can be used by any python project, e.g. Django, Pyramid, Flask, Sanic, FastAPI, Tornado, web2py etc.

Features

• Support Client part of CAS version 1.0, 2.0 and 3.0.
• Support Python 2.7, 3.5, 3.6, 3.7, 3.8, 3.9, 3.10

Documentation

• API Documentation_
• Sample integration with Flask_

Installation

Install the latest stable release with pip_::

pip install python-cas

Install the latest code::

pip install https://github.com/python-cas/python-cas/archive/master.zip

Install from source code::

git clone --depth 1 [email protected]:python-cas/python-cas.git
cd python-cas
python setup.py install

Testing

Every code commit triggers a travis-ci build. checkout current build status at https://travis-ci.org/python-cas/python-cas

Testing is managed by pytest and tox. Before run install, you need install required packages for testing::

pip install -r requirements-dev.txt

To run testing on locally::

py.test

To run all testing on all enviroments locally::

tox

Contribution

Contributions are welcome!

If you would like to contribute this project. Please feel free to fork and send pull request. Please make sure tests are passed. Also welcome to add your name to Credits section of this document.

New code should follow both PEP8_.

Credits

• django-cas_.
• Stefan Horomnea_.
• Piotr Buliński_.
• Piper Merriam_.
• Nathan Brown_.
• Jason Brownbridge_.
• Bryce Groff_.
• Jeffrey P Gill_.
• timkung1_.
• Domingo Yeray Rodríguez Martín_.
• Rayco Abad-Martín_.
• Édouard Lopez_.
• Guillaume Vincent_.
• Evgeny Fadeev_.
• Mehdi Benadda_.

References

• django-cas-ng_
• CAS protocol_
• Jasig CAS server_

.. _CAS protocol: https://djangocas.dev/docs/latest/CAS-Protocol-Specification.html .. _django-cas-ng: https://github.com/django-cas-ng/django-cas-ng .. _django-cas: https://bitbucket.org/cpcc/django-cas .. _pip: http://www.pip-installer.org/ .. _PEP8: https://www.python.org/dev/peps/pep-0008/ .. _Django coding style: https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style .. _User custom model: https://docs.djangoproject.com/en/1.5/topics/auth/customizing/ .. _Jasig CAS server: http://jasig.github.io/cas .. _Piotr Buliński: https://github.com/piotrbulinski .. _Stefan Horomnea: https://github.com/choosy .. _Piper Merriam: https://github.com/pipermerriam .. _Nathan Brown: https://github.com/tsitra .. _Jason Brownbridge: https://github.com/jbrownbridge .. _Bryce Groff: https://github.com/bgroff .. _Jeffrey P Gill: https://github.com/jpg18 .. _timkung1: https://github.com/timkung1 .. _Domingo Yeray Rodríguez Martín: https://github.com/dyeray .. _Rayco Abad-Martín: https://github.com/Rayco .. _Édouard Lopez: https://github.com/edouard-lopez .. _Guillaume Vincent: https://github.com/guillaumevincent .. _Evgeny Fadeev: https://github.com/evgenyfadeev .. _Mehdi Benadda: https://github.com/mbenadda .. _API Documentation: https://djangocas.dev/docs/latest/modules/python_cas.html .. _Sample integration with Flask: https://djangocas.dev/blog/python-cas-flask-example/