django-gauth 0.1.2__tar.gz

django_gauth-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ankit Yadav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_gauth-0.1.2/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: django_gauth
+Version: 0.1.2
+Summary: A Django app for providing the Google's discovery based Oauth2 authentication mechanism is HTTP/HTTPS oriented Django Servers/Projects.
+Author-email: Ankit Kumar <ankit.kumar05@telusdigital.com>, Ankit Yadav <ankit8290@gmail.com>
+Maintainer-email: Ankit yadav <ankit8290@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Ankit Yadav
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Documentation, https://masterpiece93.github.io/django-gauth/
+Project-URL: Repository, https://github.com/masterPiece93/django-gauth
+Project-URL: Changelog, https://github.com/masterPiece93/django-gauth/releases
+Keywords: django_gauth,google,oauth2,auth
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.1
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=3.1
+Requires-Dist: google-api-python-client
+Requires-Dist: google-auth-oauthlib
+Requires-Dist: mypy>=1.18.1
+Provides-Extra: dev
+Requires-Dist: build==1.2.1; extra == "dev"
+Requires-Dist: nox==2024.4.15; extra == "dev"
+Requires-Dist: twine==5.1.1; extra == "dev"
+Requires-Dist: check-wheel-contents; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: graphviz; extra == "dev"
+Requires-Dist: pipdeptree; extra == "dev"
+Provides-Extra: lint
+Requires-Dist: codespell>=2.2.4; extra == "lint"
+Requires-Dist: ruff; extra == "lint"
+Requires-Dist: vulture; extra == "lint"
+Requires-Dist: tomli; extra == "lint"
+Requires-Dist: validate-pyproject[all]; extra == "lint"
+Requires-Dist: isort; extra == "lint"
+Requires-Dist: black; extra == "lint"
+Requires-Dist: mypy; extra == "lint"
+Requires-Dist: pylint; extra == "lint"
+Requires-Dist: pylint-actions; extra == "lint"
+Dynamic: license-file
+
+# Google Auth <sup>[ Django ]<sup>
+
+![Static Badge](https://img.shields.io/badge/latest-0.1.2-blue)  [![pages-build-deployment](https://github.com/masterPiece93/django-gauth/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/masterPiece93/django-gauth/actions/workflows/pages/pages-build-deployment)  [![Pylint](https://github.com/masterPiece93/django-gauth/actions/workflows/pylint.yml/badge.svg)](https://github.com/masterPiece93/django-gauth/actions/workflows/pylint.yml)
+
+
+> [Official Documentation](https://masterpiece93.github.io/django-gauth/)
+
+## Installation
+
+<!-- Implement Carousal -->
+
+| Source | Command |
+| ------ | ------- |
+| **GitHub** | ```pip install -e git+https://github.com/masterPiece93/django-gauth.git#egg=django_gauth```|
+| **PyPi**| ```pip install django-gauth``` |
+
+## Quickstart
+
+1. add the app name : `django_gauth` in **INSTALLED_APPS** entry of you project ( in settings.py file )
+2. add required configuration variables ( in *settings.py* file )    
+    ```python
+    # settings.py
+    GOOGLE_CLIENT_ID= env("GOOGLE_CLIENT_ID")           # << set according to your oauth2 client
+    GOOGLE_CLIENT_SECRET= env("GOOGLE_CLIENT_SECRET")   # << set according to your oauth2 client
+    GOOGLE_AUTH_FINAL_REDIRECT_URL= None        # defaults to `<host>/gauth/`
+    CREDENTIALS_SESSION_KEY_NAME= "credentials" # defaults to `credentials`
+    STATE_KEY_NAME= "oauth_state"               # defaults to `oauth_state`
+    SCOPE= [
+        "https://www.googleapis.com/auth/userinfo.email"    # always preffered
+        ,"https://www.googleapis.com/auth/userinfo.profile" # always preffered
+        ,"openid"                                           # always preffered
+        ,"https://www.googleapis.com/auth/drive"            # based on your usage
+    ]
+    os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'         # strictly for local-development only
+    ```
+
+    - `os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'` directs the server to accept in-secure (http) connections .
+
+3. configure auth urls ( in *urls.py* file of root )
+    ```python
+    # urls.py
+    from django.contrib import admin
+    from django.urls import path, include
+
+    urlpatterns = [
+        path('admin/', admin.site.urls),
+        path('gauth/', include('django_gauth.urls')),
+        
+        # add your other app's urls
+        # ...
+
+    ]
+    ```
+* NOTE : 
+    useually all servers ( **wsgi**, **asgi**, **uWsgi**) runs default on `http://127.0.0.1:PORT/` , hence always take care to set the redirect endpoints in your google oauth2 client app in accordance with *127.0.0.1* , don't mistake to consider *localhost* , *0.0.0.0* and *127.0.0.1* as the same thing while dealing with redirect uri's . 
+    - For example : suppose you have set `http://localhost:PORT/gauth/google-callback` as your redirect uri , then take note of running your django app on localhost:PORT only !!
+
+---
+<br>
+

django_gauth-0.1.2/README.md

@@ -0,0 +1,111 @@
+# Google Auth <sup>[ Django ]<sup>
+
+![Static Badge](https://img.shields.io/badge/latest-0.1.0-blue)  [![pages-build-deployment](https://github.com/masterPiece93/django-gauth/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/masterPiece93/django-gauth/actions/workflows/pages/pages-build-deployment)  [![Pylint](https://github.com/masterPiece93/django-gauth/actions/workflows/pylint.yml/badge.svg)](https://github.com/masterPiece93/django-gauth/actions/workflows/pylint.yml)
+
+
+* [Official Documentation](https://masterpiece93.github.io/django-gauth/)
+
+## Developer Zone
+
+> [Developer README](./dev.README.md)
+
+## Installation
+
+<!-- Implement Carousal -->
+
+from GitHub :
+```sh
+# Editable Installation (for Development)
+pip install -e git+https://github.com/xavient/django-gauth.git#egg=django_gauth
+```
+
+```sh
+# Main Branch (Latest Version)
+pip install git+https://github.com/xavient/django-gauth.git
+```
+
+from PyPi
+```sh
+pip install django-gauth
+```
+
+from test PyPi
+```sh
+pip install -i https://test.pypi.org/simple/ django-gauth
+```
+
+## Quickstart
+
+1. add the app name : `django_gauth` in **INSTALLED_APPS** entry of you project ( in settings.py file )
+2. add required configuration variables ( in *settings.py* file )    
+    ```python
+    # settings.py
+    GOOGLE_CLIENT_ID= env("GOOGLE_CLIENT_ID")           # << set according to your oauth2 client
+    GOOGLE_CLIENT_SECRET= env("GOOGLE_CLIENT_SECRET")   # << set according to your oauth2 client
+    GOOGLE_AUTH_FINAL_REDIRECT_URL= None        # defaults to `<host>/gauth/`
+    CREDENTIALS_SESSION_KEY_NAME= "credentials" # defaults to `credentials`
+    STATE_KEY_NAME= "oauth_state"               # defaults to `oauth_state`
+    SCOPE= [
+        "https://www.googleapis.com/auth/userinfo.email"    # always preffered
+        ,"https://www.googleapis.com/auth/userinfo.profile" # always preffered
+        ,"openid"                                           # always preffered
+        ,"https://www.googleapis.com/auth/drive"            # based on your usage
+    ]
+    os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'         # strictly for local-development only
+    ```
+
+    - `os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'` directs the server to accept in-secure (http) connections .
+
+3. configure auth urls ( in *urls.py* file of root )
+    ```python
+    # urls.py
+    from django.contrib import admin
+    from django.urls import path, include
+
+    urlpatterns = [
+        path('admin/', admin.site.urls),
+        path('gauth/', include('django_gauth.urls')),
+        
+        # add your other app's urls
+        # ...
+
+    ]
+    ```
+> NOTE : useually all servers ( wsgi, asgi, uWsgi) runs default on `http://127.0.0.1:PORT/` , hence always take care to set the redirect endpoints in your google oauth2 client app in accordance with 127.0.0.1 , don't mistake to consider localhost , 0.0.0.0 and 127.0.0.1 as same while dealing with redirect uri's . For example : suppose you have set `http://localhost:PORT/gauth/google-callback` as your redirect uri , then take note of running your django app on localhost only !!
+
+> NOTE : 
+---
+<br>
+
+### Important Points <sup> <small>To Be Noted</small> </sup>
+
+for production applications , that are working on http**s** , must ensure the following settings for django to be http**s** aware :
+```sh
+USE_X_FORWARDED_HOST = True
+SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
+```
+
+Your reverse proxy should add the X-Forwarded-Proto: https header to requests forwarded to Django.
+Configure your reverse proxy to set X-Forwarded-Proto header ( Nginx Example ):
+```sh
+server {
+    listen 80;
+    server_name yourdomain.com;
+    return 301 https://$host$request_uri;
+}
+
+server {
+    listen 443 ssl;
+    server_name yourdomain.com;
+
+    # ... SSL configuration ...
+
+    location / {
+        proxy_pass http://your_django_app_server;
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto https; # Crucial line
+    }
+}
+```

django_gauth-0.1.2/pypi.README.md

@@ -0,0 +1,60 @@
+# Google Auth <sup>[ Django ]<sup>
+
+![Static Badge](https://img.shields.io/badge/latest-0.1.2-blue)  [![pages-build-deployment](https://github.com/masterPiece93/django-gauth/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/masterPiece93/django-gauth/actions/workflows/pages/pages-build-deployment)  [![Pylint](https://github.com/masterPiece93/django-gauth/actions/workflows/pylint.yml/badge.svg)](https://github.com/masterPiece93/django-gauth/actions/workflows/pylint.yml)
+
+
+> [Official Documentation](https://masterpiece93.github.io/django-gauth/)
+
+## Installation
+
+<!-- Implement Carousal -->
+
+| Source | Command |
+| ------ | ------- |
+| **GitHub** | ```pip install -e git+https://github.com/masterPiece93/django-gauth.git#egg=django_gauth```|
+| **PyPi**| ```pip install django-gauth``` |
+
+## Quickstart
+
+1. add the app name : `django_gauth` in **INSTALLED_APPS** entry of you project ( in settings.py file )
+2. add required configuration variables ( in *settings.py* file )    
+    ```python
+    # settings.py
+    GOOGLE_CLIENT_ID= env("GOOGLE_CLIENT_ID")           # << set according to your oauth2 client
+    GOOGLE_CLIENT_SECRET= env("GOOGLE_CLIENT_SECRET")   # << set according to your oauth2 client
+    GOOGLE_AUTH_FINAL_REDIRECT_URL= None        # defaults to `<host>/gauth/`
+    CREDENTIALS_SESSION_KEY_NAME= "credentials" # defaults to `credentials`
+    STATE_KEY_NAME= "oauth_state"               # defaults to `oauth_state`
+    SCOPE= [
+        "https://www.googleapis.com/auth/userinfo.email"    # always preffered
+        ,"https://www.googleapis.com/auth/userinfo.profile" # always preffered
+        ,"openid"                                           # always preffered
+        ,"https://www.googleapis.com/auth/drive"            # based on your usage
+    ]
+    os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'         # strictly for local-development only
+    ```
+
+    - `os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'` directs the server to accept in-secure (http) connections .
+
+3. configure auth urls ( in *urls.py* file of root )
+    ```python
+    # urls.py
+    from django.contrib import admin
+    from django.urls import path, include
+
+    urlpatterns = [
+        path('admin/', admin.site.urls),
+        path('gauth/', include('django_gauth.urls')),
+        
+        # add your other app's urls
+        # ...
+
+    ]
+    ```
+* NOTE : 
+    useually all servers ( **wsgi**, **asgi**, **uWsgi**) runs default on `http://127.0.0.1:PORT/` , hence always take care to set the redirect endpoints in your google oauth2 client app in accordance with *127.0.0.1* , don't mistake to consider *localhost* , *0.0.0.0* and *127.0.0.1* as the same thing while dealing with redirect uri's . 
+    - For example : suppose you have set `http://localhost:PORT/gauth/google-callback` as your redirect uri , then take note of running your django app on localhost:PORT only !!
+
+---
+<br>
+

django_gauth-0.1.2/pyproject.toml

@@ -0,0 +1,290 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "django_gauth"
+version = "0.1.2"
+authors = [
+    {name = "Ankit Kumar", email = "ankit.kumar05@telusdigital.com"},
+    {name = "Ankit Yadav", email = "ankit8290@gmail.com"},
+]
+maintainers = [
+    {name = "Ankit yadav", email="ankit8290@gmail.com"},
+]
+description = "A Django app for providing the Google's discovery based Oauth2 authentication mechanism is HTTP/HTTPS oriented Django Servers/Projects."
+readme = "pypi.README.md"
+license = {file = "LICENSE"}
+keywords = ["django_gauth", "google", "oauth2", "auth"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Framework :: Django :: 3.1",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Utilities",
+    "Typing :: Typed"
+]
+requires-python = ">=3.9"
+dependencies = [
+    "Django>=3.1",
+    "google-api-python-client",
+    "google-auth-oauthlib",
+    "mypy>=1.18.1",
+]
+
+[project.urls]
+#Homepage = "/"
+Documentation = "https://masterpiece93.github.io/django-gauth/"
+Repository = "https://github.com/masterPiece93/django-gauth"
+Changelog = "https://github.com/masterPiece93/django-gauth/releases"
+
+[project.optional-dependencies]
+dev = [
+
+    # building package
+    "build==1.2.1",
+
+    # multiple python platforms testing
+    "nox==2024.4.15",
+
+    # PyPi Hosting
+    "twine==5.1.1",
+
+    # Build Verification
+    "check-wheel-contents",
+
+    # Typechecking
+    "mypy",
+
+    # Analyzing dependencies
+    "graphviz",
+    "pipdeptree",
+]
+lint = [
+    # checks for spelling mistakes
+    "codespell>=2.2.4",
+
+    # ruff linter checks for issues and potential bugs
+    "ruff",
+
+    # checks for unused code
+    "vulture",
+
+    # required for codespell to parse pyproject.toml
+    "tomli",
+
+    # validation of pyproject.toml
+    "validate-pyproject[all]",
+
+    # automatic sorting of imports
+    "isort",
+
+    # automatic code formatting to follow a consistent style
+    "black",
+
+    # Typechecking
+    "mypy",
+
+    # logical linting
+    "pylint",
+    "pylint-actions",
+]
+
+# Tools 
+# -----
+
+# PDM example
+[tool.pdm]
+distribution = true
+
+[tool.pdm.scripts]
+isort = "isort src/django_gauth"
+black = "black src/django_gauth"
+format = {composite = ["isort", "black"]}
+check_isort = "isort --check src/django_gauth"
+check_black = "black --check src/django_gauth"
+vulture = "vulture --min-confidence 100 src/django_gauth"
+ruff = "ruff check --show-files src/django_gauth"
+fix = "ruff check --fix src/django_gauth"
+# codespell = "codespell --toml ./pyproject.toml" # Not Working Properly
+lint = {composite = ["vulture", "ruff", "check_isort", "check_black"]}
+mypy = "mypy src/"
+pylint = "pylint -f actions src/"
+check_build = "check-wheel-contents dist/"
+
+[tool.black]
+line-length = 88
+# If you need to exclude directories from being reformatted by black
+# force-exclude = '''
+# (
+#     somedirname
+#     | dirname
+#     | filename\.py
+# )
+# '''
+
+
+[tool.isort]
+profile = "black"
+known_first_party = ["acme"]
+# If you need to exclude files from having their imports sorted
+extend_skip_glob  = [
+    "acme/somefile.py",
+    "acme/somedir/*",
+]
+
+
+# https://beta.ruff.rs/docs
+[tool.ruff]
+line-length = 99
+
+# Rules: https://beta.ruff.rs/docs/rules
+# If you violate a rule, lookup the rule on the Rules page in ruff docs.
+# Many rules have links you can click with a explanation of the rule and how to fix it.
+# If there isn't a link, go to the project the rule was source from (e.g. flake8-bugbear)
+# and review it's docs for the corresponding rule.
+# If you're still confused, ask a fellow developer for assistance.
+# You can also run "ruff rule <rule>" to explain a rule on the command line, without a browser or internet access.
+select = [
+    "E",    # pycodestyle
+    "F",    # Pyflakes
+    "W",    # Warning
+    "B",    # flake8-bugbear
+    "A",    # flake8-builtins
+    "C4",   # flake8-comprehensions
+    "T10",  # flake8-debugger
+    "EXE",  # flake8-executable,
+    "ISC",  # flake8-implicit-str-concat
+    "G",    # flake8-logging-format
+    "PIE",  # flake8-pie
+    "T20",  # flake8-print
+    "PT",   # flake8-pytest-style
+    "RSE",  # flake8-raise
+    "RET",  # flake8-return
+    "TID",  # flake8-tidy-imports
+    "ARG",  # flake8-unused-arguments
+    "PGH",  # pygrep-hooks
+    "PLC",  # Pylint Convention
+    "PLE",  # Pylint Errors
+    "PLW",  # Pylint Warnings
+    "RUF",  # Ruff-specific rules
+
+    # ** Things to potentially enable in the future **
+    # DTZ requires all usage of datetime module to have timezone-aware
+    # objects (so have a tz argument or be explicitly UTC).
+    # "DTZ",  # flake8-datetimez
+    # "PTH",  # flake8-use-pathlib
+    # "SIM",  # flake8-simplify
+]
+
+# Files to exclude from linting
+extend-exclude = [
+    "*.pyc",
+    "__pycache__",
+]
+
+# Linting error codes to ignore
+ignore = [
+    "F403",    # unable to detect undefined names from star imports
+    "F405",    # undefined locals from star imports
+    "W605",    # invalid escape sequence
+    "A003",    # shadowing python builtins
+    "RET505",  # unnecessary 'else' after 'return' statement
+    "RET504",  # Unnecessary variable assignment before return statement
+    "RET507",  # Unnecessary {branch} after continue statement
+    "PT011",   # pytest-raises-too-broad
+    "PT012",   # pytest.raises() block should contain a single simple statement
+    "PLW0603", # Using the global statement to update is discouraged
+    "PLW2901", # for loop variable overwritten by assignment target
+    "G004",    # Logging statement uses f-string
+    "PIE790",  # no-unnecessary-pass
+    "PIE810",  # multiple-starts-ends-with
+    "PGH003",  # Use specific rule codes when ignoring type issues
+    "PLC1901", # compare-to-empty-string
+]
+
+# Linting error codes to ignore on a per-file basis
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401", "E501"]
+"acme/somefile.py" = ["E402", "E501"]
+"acme/somedir/*" = ["E501"]
+
+# MyPy
+[tool.mypy]
+python_version = "3.12"
+follow_imports = "skip"
+ignore_missing_imports = true
+files = "src"  # directory mypy should analyze
+exclude = [     # Directories to exclude from mypy's analysis
+    "acme/somedir",
+    "acme/somefile\\.py",
+    "dirname",
+    "src/django_gauth/admin\\.py"
+]
+
+[[tool.mypy.overrides]]
+module = "django_gauth.*"
+ignore_missing_imports = false
+disallow_untyped_defs = true
+check_untyped_defs = true
+
+# Configuration for pytest
+# https://docs.pytest.org/en/latest/reference/customize.html#pyproject-toml
+[tool.pytest.ini_options]
+testpaths = "tests"  # directory containing your tests
+norecursedirs = [
+    ".vscode",
+    "__pycache__"
+]
+# Warnings that should be ignored
+filterwarnings = [
+    "ignore::DeprecationWarning"
+]
+# custom markers that can be used using pytest.mark
+markers = [
+    "slow: lower-importance tests that take an excessive amount of time",
+]
+
+
+# Configuration for coverage.py
+[tool.coverage.run]
+# files or directories to exclude from coverage calculations
+omit = [
+    'acme/somedir/*',
+    'acme/somefile.py',
+]
+
+
+# Configuration for vulture
+[tool.vulture]
+# Files or directories to exclude from vulture
+# The syntax is a little funky
+exclude = [
+    "somedir",
+    "*somefile.py",
+]
+
+# Configuration for Pylint
+[tool.pylint.main]
+load-plugins = "pylint_actions" # Optional, for GitHub Actions annotations
+disable = [
+    "C0114", # Missing module docstring
+    "C0116", # Missing function or method docstring
+]
+max-line-length = 100
+
+[tool.pylint.messages_control]
+good-names = ["i", "j", "k", "ex", "Run", "_"]

django_gauth-0.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

django_gauth-0.1.2/src/django_gauth/__init__.py

@@ -0,0 +1,5 @@
+"""
+Gauth Application
+=================
+Author : Ankit Kumar ( ankit.kumar05@telusdigital.com )
+"""

django_gauth-0.1.2/src/django_gauth/admin.py

@@ -0,0 +1,24 @@
+import pprint
+from django.contrib import admin                    # pylint: disable=E0401
+from django.contrib.sessions.models import Session  # pylint: disable=E0401
+
+# pylint: disable=R0903
+class SessionAdmin(admin.ModelAdmin):
+    """
+    Session information on admin panel
+    """
+    list_display = ["session_key", "_session_data", "expire_date"]
+    readonly_fields = ["_session_data"]
+    exclude = [
+        "session_data"
+    ]  # This line ensures that encoded session in not shown .
+       #    Comment this if you want to see the encoded session data as well .
+
+    def _session_data(self, obj):
+
+        return pprint.pformat(obj.get_decoded()).replace("\n", "<br>\n")
+
+    _session_data.allow_tags = True
+
+
+admin.site.register(Session, SessionAdmin)

django_gauth-0.1.2/src/django_gauth/apps.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig   # pylint: disable=E0401
+
+# pylint: disable=R0903
+class DjangoGauthConfig(AppConfig):
+    """
+    App Configurator @ django_gauth
+    """
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "django_gauth"

django_gauth-0.1.2/src/django_gauth/defaults.py

@@ -0,0 +1,8 @@
+from typing import Final, Optional
+
+GOOGLE_AUTH_FINAL_REDIRECT_URL: Final[Optional[str]] = (
+    None  # auto selects django_gauth > index.html
+)
+CREDENTIALS_SESSION_KEY_NAME: Final[str] = "credentials"
+STATE_KEY_NAME: Final[str] = "oauth_state"
+FINAL_REDIRECT_KEY_NAME: Final[str] = "final_redirect"

django_gauth-0.1.2/src/django_gauth/urls.py

@@ -0,0 +1,17 @@
+# urls
+
+from django.urls import path    # pylint: disable=E0401
+
+from . import views
+
+# this key is used when you refer an endpoint by `reverse`
+app_name = "django_gauth"  # pylint: disable=C0103
+
+urlpatterns = [
+    path("", views.index, name="index"),
+    path("login/", views.login, name="login"),
+    path("login-callback", views.callback, name="callback"),
+]
+
+# NOTE : `/` at the end of the route will be taken in cosideration while redirected .
+# # if you have strict slashes issues , do take care where to put the `/` or not .

django_gauth-0.1.2/src/django_gauth/utilities.py

@@ -0,0 +1,73 @@
+import time
+from typing import Any, Dict, Tuple, Union
+from urllib.parse import urlparse
+
+from django.conf import Settings, settings          # pylint: disable=E0401
+from google.oauth2.credentials import Credentials   # pylint: disable=E0401
+
+__all__ = [
+    "credentials_to_dict",
+    "has_epoch_time_passed",
+    "check_gauth_authentication",
+    "is_valid_google_url",
+]
+
+
+def credentials_to_dict(credentials: Credentials) -> Dict[str, Any]:
+    return {
+        "token": credentials.token,
+        "refresh_token": credentials.refresh_token,
+        "token_uri": credentials.token_uri,
+        "client_id": credentials.client_id,
+        "client_secret": credentials.client_secret,
+        "scopes": credentials.scopes,
+    }
+
+
+def has_epoch_time_passed(target_epoch_time: Union[int, float]) -> bool:
+    """
+    Checks if a given epoch time has passed.
+
+    Args:
+        target_epoch_time (float or int): The epoch time to check (seconds since epoch).
+
+    Returns:
+        bool: True if the target epoch time has passed, False otherwise.
+    """
+    current_epoch_time = time.time()
+    return target_epoch_time <= current_epoch_time
+
+
+def check_gauth_authentication(session: Settings) -> Tuple[bool, object]:
+    """
+    checks if authentication session still valid
+    """
+    credentials_session_key = settings.CREDENTIALS_SESSION_KEY_NAME or "credentials"
+
+    if credentials_session_key not in session:
+        return False, None
+
+    # Load credentials from the session.
+    credentials = Credentials(**session[credentials_session_key])
+
+    if not credentials.valid:
+        return False, None
+
+    if "id_info" in session and has_epoch_time_passed(session["id_info"]["exp"]):
+        return False, None
+
+    return True, credentials
+
+
+def is_valid_google_url(url: str) -> bool:
+    VALID_SCHEME = "https"              # pylint: disable=C0103
+    VALID_DOMAIN = "docs.google.com"    # pylint: disable=C0103
+    try:
+        result = urlparse(url)
+        return (
+            all([result.scheme, result.netloc])
+            and result.scheme == VALID_SCHEME
+            and result.netloc == VALID_DOMAIN
+        )
+    except ValueError:
+        return False

django_gauth-0.1.2/src/django_gauth/views.py

@@ -0,0 +1,149 @@
+"""
+Auth Api's
+~@ankit.kumar05
+"""
+
+from django.conf import settings                # pylint: disable=E0401
+from django.shortcuts import redirect, render   # pylint: disable=E0401
+from django.urls import reverse                 # pylint: disable=E0401
+from google.auth.transport import requests      # pylint: disable=E0401
+from google.oauth2 import id_token              # pylint: disable=E0401
+from google_auth_oauthlib.flow import Flow      # pylint: disable=E0401
+
+from django_gauth import defaults
+from django_gauth.utilities import check_gauth_authentication, credentials_to_dict
+
+if hasattr(settings, "SCOPE") and settings.SCOPE:
+    SCOPE = settings.SCOPE
+else:
+    SCOPE = []
+
+if (
+    hasattr(settings, "GOOGLE_AUTH_FINAL_REDIRECT_URL")
+    and settings.GOOGLE_AUTH_FINAL_REDIRECT_URL
+):
+    GOOGLE_AUTH_FINAL_REDIRECT_URL = settings.GOOGLE_AUTH_FINAL_REDIRECT_URL
+else:
+    GOOGLE_AUTH_FINAL_REDIRECT_URL = defaults.GOOGLE_AUTH_FINAL_REDIRECT_URL
+
+if (
+    hasattr(settings, "CREDENTIALS_SESSION_KEY_NAME")
+    and settings.CREDENTIALS_SESSION_KEY_NAME
+):
+    CREDENTIALS_SESSION_KEY_NAME = settings.CREDENTIALS_SESSION_KEY_NAME
+else:
+    CREDENTIALS_SESSION_KEY_NAME = defaults.CREDENTIALS_SESSION_KEY_NAME
+
+if hasattr(settings, "STATE_KEY_NAME") and settings.STATE_KEY_NAME:
+    STATE_KEY_NAME = settings.STATE_KEY_NAME
+else:
+    STATE_KEY_NAME = defaults.STATE_KEY_NAME
+
+if hasattr(settings, "FINAL_REDIRECT_KEY_NAME") and settings.FINAL_REDIRECT_KEY_NAME:
+    FINAL_REDIRECT_KEY_NAME = settings.STATE_KEY_NAME
+else:
+    FINAL_REDIRECT_KEY_NAME = defaults.FINAL_REDIRECT_KEY_NAME
+
+
+def index(request):  # type: ignore
+    is_authenticated, _ = check_gauth_authentication(request.session)
+    id_info = request.session.get("id_info", {})
+
+    id_info.pop("iss", None)
+    id_info.pop("azp", None)
+    id_info.pop("aud", None)
+    id_info.pop("sub", None)
+
+    context: dict = {
+        "title": "",
+        "login_href": reverse("django_gauth:login"),
+        "user_info": id_info,
+        "is_authenticated": is_authenticated,
+    }
+    return render(request, "django_gauth/index.html", {"context_data": context})
+
+
+def login(request):  # type: ignore
+    """Login Api
+    - Initiates the oauth2 Flow
+    """
+    flow = Flow.from_client_config(
+        client_config={
+            "web": {
+                "client_id": settings.GOOGLE_CLIENT_ID,
+                "client_secret": settings.GOOGLE_CLIENT_SECRET,
+                "auth_uri": "https://accounts.google.com/o/oauth2/v2/auth",
+                "token_uri": "https://oauth2.googleapis.com/token",
+            }
+        }
+        # if you need additional scopes, add them here
+        ,
+        scopes=SCOPE,
+    )
+
+    # flow.redirect_uri = get_redirect_uri(request) # use this when
+    flow.redirect_uri = request.build_absolute_uri(reverse("django_gauth:callback"))
+
+    authorization_url, state = flow.authorization_url(
+        access_type="offline", prompt="select_account", include_granted_scopes="true"
+    )
+
+    request.session[STATE_KEY_NAME] = state
+    if (
+        "final_redirect" not in request.session
+        or not request.session[FINAL_REDIRECT_KEY_NAME]
+    ):
+        request.session[FINAL_REDIRECT_KEY_NAME] = (
+            GOOGLE_AUTH_FINAL_REDIRECT_URL
+            or request.build_absolute_uri(reverse("django_gauth:index"))
+        )  # directs where to land after login is successful.
+
+    return redirect(authorization_url)
+
+
+def callback(request):  # type: ignore
+    """Google Oauth2 Callback
+    - Google IDP response control transfer
+    """
+    # pull the state from the session
+    session_state = request.session.get(STATE_KEY_NAME)
+    redirect_uri = request.build_absolute_uri(reverse("django_gauth:callback"))
+    authorization_response = request.build_absolute_uri()
+    # Flow Creation
+    flow = Flow.from_client_config(
+        client_config={
+            "web": {
+                "client_id": settings.GOOGLE_CLIENT_ID,
+                "client_secret": settings.GOOGLE_CLIENT_SECRET,
+                "auth_uri": "https://accounts.google.com/o/oauth2/v2/auth",
+                "token_uri": "https://oauth2.googleapis.com/token",
+            }
+        },
+        scopes=[
+            "https://www.googleapis.com/auth/userinfo.email",
+            "https://www.googleapis.com/auth/userinfo.profile",
+            "openid",
+            "https://www.googleapis.com/auth/drive",
+        ],
+        state=session_state,
+    )
+
+    flow.redirect_uri = redirect_uri
+    # fetch token
+    flow.fetch_token(authorization_response=authorization_response)
+    # get credentials
+    credentials = flow.credentials
+    # verify token, while also retrieving information about the user
+    id_info = id_token.verify_oauth2_token(
+        id_token=credentials._id_token,     # pylint: disable=W0212
+        request=requests.Request(),
+        audience=settings.GOOGLE_CLIENT_ID,
+        clock_skew_in_seconds=5,
+    )
+    # session setting
+    request.session["id_info"] = id_info
+    request.session[CREDENTIALS_SESSION_KEY_NAME] = credentials_to_dict(credentials)
+    # redirecting to the final redirect (i.e., logged in page)
+    redirect_response = redirect(request.session[FINAL_REDIRECT_KEY_NAME])
+
+    return redirect_response

django_gauth-0.1.2/src/django_gauth.egg-info/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: django_gauth
+Version: 0.1.2
+Summary: A Django app for providing the Google's discovery based Oauth2 authentication mechanism is HTTP/HTTPS oriented Django Servers/Projects.
+Author-email: Ankit Kumar <ankit.kumar05@telusdigital.com>, Ankit Yadav <ankit8290@gmail.com>
+Maintainer-email: Ankit yadav <ankit8290@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Ankit Yadav
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Documentation, https://masterpiece93.github.io/django-gauth/
+Project-URL: Repository, https://github.com/masterPiece93/django-gauth
+Project-URL: Changelog, https://github.com/masterPiece93/django-gauth/releases
+Keywords: django_gauth,google,oauth2,auth
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.1
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=3.1
+Requires-Dist: google-api-python-client
+Requires-Dist: google-auth-oauthlib
+Requires-Dist: mypy>=1.18.1
+Provides-Extra: dev
+Requires-Dist: build==1.2.1; extra == "dev"
+Requires-Dist: nox==2024.4.15; extra == "dev"
+Requires-Dist: twine==5.1.1; extra == "dev"
+Requires-Dist: check-wheel-contents; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: graphviz; extra == "dev"
+Requires-Dist: pipdeptree; extra == "dev"
+Provides-Extra: lint
+Requires-Dist: codespell>=2.2.4; extra == "lint"
+Requires-Dist: ruff; extra == "lint"
+Requires-Dist: vulture; extra == "lint"
+Requires-Dist: tomli; extra == "lint"
+Requires-Dist: validate-pyproject[all]; extra == "lint"
+Requires-Dist: isort; extra == "lint"
+Requires-Dist: black; extra == "lint"
+Requires-Dist: mypy; extra == "lint"
+Requires-Dist: pylint; extra == "lint"
+Requires-Dist: pylint-actions; extra == "lint"
+Dynamic: license-file
+
+# Google Auth <sup>[ Django ]<sup>
+
+![Static Badge](https://img.shields.io/badge/latest-0.1.2-blue)  [![pages-build-deployment](https://github.com/masterPiece93/django-gauth/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/masterPiece93/django-gauth/actions/workflows/pages/pages-build-deployment)  [![Pylint](https://github.com/masterPiece93/django-gauth/actions/workflows/pylint.yml/badge.svg)](https://github.com/masterPiece93/django-gauth/actions/workflows/pylint.yml)
+
+
+> [Official Documentation](https://masterpiece93.github.io/django-gauth/)
+
+## Installation
+
+<!-- Implement Carousal -->
+
+| Source | Command |
+| ------ | ------- |
+| **GitHub** | ```pip install -e git+https://github.com/masterPiece93/django-gauth.git#egg=django_gauth```|
+| **PyPi**| ```pip install django-gauth``` |
+
+## Quickstart
+
+1. add the app name : `django_gauth` in **INSTALLED_APPS** entry of you project ( in settings.py file )
+2. add required configuration variables ( in *settings.py* file )    
+    ```python
+    # settings.py
+    GOOGLE_CLIENT_ID= env("GOOGLE_CLIENT_ID")           # << set according to your oauth2 client
+    GOOGLE_CLIENT_SECRET= env("GOOGLE_CLIENT_SECRET")   # << set according to your oauth2 client
+    GOOGLE_AUTH_FINAL_REDIRECT_URL= None        # defaults to `<host>/gauth/`
+    CREDENTIALS_SESSION_KEY_NAME= "credentials" # defaults to `credentials`
+    STATE_KEY_NAME= "oauth_state"               # defaults to `oauth_state`
+    SCOPE= [
+        "https://www.googleapis.com/auth/userinfo.email"    # always preffered
+        ,"https://www.googleapis.com/auth/userinfo.profile" # always preffered
+        ,"openid"                                           # always preffered
+        ,"https://www.googleapis.com/auth/drive"            # based on your usage
+    ]
+    os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'         # strictly for local-development only
+    ```
+
+    - `os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = '1'` directs the server to accept in-secure (http) connections .
+
+3. configure auth urls ( in *urls.py* file of root )
+    ```python
+    # urls.py
+    from django.contrib import admin
+    from django.urls import path, include
+
+    urlpatterns = [
+        path('admin/', admin.site.urls),
+        path('gauth/', include('django_gauth.urls')),
+        
+        # add your other app's urls
+        # ...
+
+    ]
+    ```
+* NOTE : 
+    useually all servers ( **wsgi**, **asgi**, **uWsgi**) runs default on `http://127.0.0.1:PORT/` , hence always take care to set the redirect endpoints in your google oauth2 client app in accordance with *127.0.0.1* , don't mistake to consider *localhost* , *0.0.0.0* and *127.0.0.1* as the same thing while dealing with redirect uri's . 
+    - For example : suppose you have set `http://localhost:PORT/gauth/google-callback` as your redirect uri , then take note of running your django app on localhost:PORT only !!
+
+---
+<br>
+

django_gauth-0.1.2/src/django_gauth.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+README.md
+pypi.README.md
+pyproject.toml
+src/django_gauth/__init__.py
+src/django_gauth/admin.py
+src/django_gauth/apps.py
+src/django_gauth/defaults.py
+src/django_gauth/py.typed
+src/django_gauth/urls.py
+src/django_gauth/utilities.py
+src/django_gauth/views.py
+src/django_gauth.egg-info/PKG-INFO
+src/django_gauth.egg-info/SOURCES.txt
+src/django_gauth.egg-info/dependency_links.txt
+src/django_gauth.egg-info/requires.txt
+src/django_gauth.egg-info/top_level.txt

django_gauth-0.1.2/src/django_gauth.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django_gauth-0.1.2/src/django_gauth.egg-info/requires.txt

@@ -0,0 +1,25 @@
+Django>=3.1
+google-api-python-client
+google-auth-oauthlib
+mypy>=1.18.1
+
+[dev]
+build==1.2.1
+nox==2024.4.15
+twine==5.1.1
+check-wheel-contents
+mypy
+graphviz
+pipdeptree
+
+[lint]
+codespell>=2.2.4
+ruff
+vulture
+tomli
+validate-pyproject[all]
+isort
+black
+mypy
+pylint
+pylint-actions

django_gauth-0.1.2/src/django_gauth.egg-info/top_level.txt

@@ -0,0 +1 @@
+django_gauth