https://github.com/python-cas/python-cas

Python CAS (Central Authentication Service) client library support CAS 1.0/2.0/3.0
https://github.com/python-cas/python-cas

authentication cas casclient python single-sign-on

Last synced: 3 months ago
JSON representation

Python CAS (Central Authentication Service) client library support CAS 1.0/2.0/3.0

• Host: GitHub
• URL: https://github.com/python-cas/python-cas
• Owner: python-cas
• License: mit
• Created: 2015-06-16T16:23:38.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-09-27T16:19:44.000Z (about 1 year ago)
• Last Synced: 2024-07-20T11:08:11.058Z (4 months ago)
• Topics: authentication, cas, casclient, python, single-sign-on
• Language: Python
• Homepage: https://djangocas.dev/docs/latest/modules/python_cas.html
• Size: 949 KB
• Stars: 88
• Watchers: 7
• Forks: 47
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
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/