Skip to main content

Python Social Authentication, Django integration, Google compliant fork

Project description

Compliant Social App Django

This is a Google compliant fork of the Django component of the python-social-auth ecosystem, it implements the needed functionality to integrate social-auth-core in a Django based project.

Python Social Auth - Django

Python Social Auth is an easy to setup social authentication/registration mechanism with support for several frameworks and auth providers.

Django version

This project will focus on the currently supported Django releases as stated on the Django Project Supported Versions table.

Backward compatibility with unsupported versions won't be enforced.

Documentation

Compliant Social App Django provides three key features required to comply with Google's standards for applications that ask for restricted scopes such as the ability to read gmail inboxes:

  1. Storing the access and refresh tokens encrypted in the database.
  2. The encryption of those tokens being backed by KMS.
  3. Audit logs that register the access to and revocation of those same tokens.

An Audit Logger object must be provided to the app, and must inherit from the abstract base audit logger provided. We also provide an alternative Google backend that uses the audit logger.

KMS must be set up independently, and you must specify a KMS_FIELD_KEY in settings; typically the alias of your KMS key.

If moving to this package from the main social-app-django package the db migrations will also handle the migration of tokens, with encryption, into their appropriate fields.

Core project documentation is available at https://python-social-auth.readthedocs.org/.

Setup

$ pip install compliant-social-app-django

Versioning

This project follows Semantic Versioning 2.0.0.

This fork's versioning will match the major version of the original package version upon which it is based

Building and Releasing

To release a new version use these steps:

  1. Increment the version number in __init.py__
  2. Update the CHANGELOG.md with description of the changes in the release (and commit)
  3. Remove the build and dist directories completely
    rm -rf build dist
    
  4. Build the source distribution:
    python setup.py sdist
    
  5. Push the distribution. You'll need to configure your ~/.pypirc file to authenticate with Pypi using an API token before running this.
    python -m twine upload --repository compliant-social-app-django dist/*
    
  6. Tag the release and push the tag

License

This project follows the BSD license. See the LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

compliant_social_app_django-5.4.1.tar.gz (30.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file compliant_social_app_django-5.4.1.tar.gz.

File metadata

File hashes

Hashes for compliant_social_app_django-5.4.1.tar.gz
Algorithm Hash digest
SHA256 74e85926b01c8be85fffd185ecd0a07b62b0ee8bd48143eae0cac69388e483dc
MD5 349ce34dd88b6ea3b6741500187fbf39
BLAKE2b-256 de815f4a3ca8f14a733a2748a86f4996f81c7e0585c629ea3bfcdf12d8d7c452

See more details on using hashes here.

File details

Details for the file compliant_social_app_django-5.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for compliant_social_app_django-5.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c8af9a9bf80a760ecc0ab819c1e29400293b7ab74c234dd3c223815e70b9d45
MD5 42a8ae2d480c7c0175dbc0d0db0318b3
BLAKE2b-256 6d1a8deeda8d07831fc0cd967132329e626642787ed7f6fb369041ded5fa2c8e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page