oauth2-cli-auth 1.2.0__tar.gz → 1.4.0__tar.gz

{oauth2_cli_auth-1.2.0 → oauth2_cli_auth-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oauth2-cli-auth
-Version: 1.2.0
+Version: 1.4.0
 Summary: Authenticate against OAuth2 Provider in Python CLIs
 Home-page: https://github.com/timo-reymann/python-oauth2-cli-auth
 License: MIT
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Project-URL: Bug Tracker, https://github.com/timo-reymann/python-oauth2-cli-auth/issues
 Project-URL: Repository, https://github.com/timo-reymann/python-oauth2-cli-auth
 Description-Content-Type: text/markdown

{oauth2_cli_auth-1.2.0 → oauth2_cli_auth-1.4.0}/oauth2_cli_auth/_timeout.py

@@ -16,7 +16,7 @@ def _method_with_timeout(your_method, timeout_seconds=5, *args, **kwargs):
     try:
         result = your_method(*args, **kwargs)
     except TimeoutException as te:
-       raise te
+        raise te
     finally:
         signal.alarm(0)  # Reset the alarm
 

{oauth2_cli_auth-1.2.0 → oauth2_cli_auth-1.4.0}/oauth2_cli_auth/_urllib_util.py

@@ -1,6 +1,7 @@
 import json
 import time
 import urllib
+from urllib.error import URLError
 
 
 def _urlopen_with_backoff(url, max_retries=3, base_delay=1, timeout=15):
@@ -15,7 +16,7 @@ def _urlopen_with_backoff(url, max_retries=3, base_delay=1, timeout=15):
             delay = base_delay * (2 ** retries)
             time.sleep(delay)
 
-    raise Exception(f"Failed to open URL after {max_retries} retries")
+    raise URLError(f"Failed to open URL after {max_retries} retries")
 
 
 def _load_json(url_or_request: str | urllib.request.Request) -> dict:

{oauth2_cli_auth-1.2.0 → oauth2_cli_auth-1.4.0}/oauth2_cli_auth/code_grant.py

@@ -1,8 +1,13 @@
+"""
+Functionality to work with OAuth2 code grant
+"""
+import base64
+import urllib.parse
+import urllib.request
 import webbrowser
+from collections.abc import Callable
 from dataclasses import dataclass
-import urllib.request
-import urllib.parse
-import base64
+
 from oauth2_cli_auth._urllib_util import _load_json
 
 
@@ -32,17 +37,24 @@ class OAuth2ClientInfo:
 
 
 def load_oidc_config(odic_well_known_endpoint: str) -> dict:
+    """
+    Load OIDC configuration from the well known configuration endpoint
+
+    :param odic_well_known_endpoint: Endpoint to load configuration from
+    """
     config = _load_json(odic_well_known_endpoint)
     return config
 
 
-def open_browser(url: str) -> None:
+def open_browser(url: str, print_open_browser_instruction: Callable[[str], None] | None = print) -> None:
     """
     Open browser using webbrowser module and show message about URL open
+    :param print_open_browser_instruction: Callback to print the instructions to open the browser. Set to None in order to supress the output.
     :param url: URL to open and display
     :return: None
     """
-    print(f"Open your browser at\n{url}")
+    if print_open_browser_instruction is not None:
+        print_open_browser_instruction(f"Open your browser at\n{url}")
     webbrowser.open(url)
 
 
@@ -61,17 +73,18 @@ def get_auth_url(client_info: OAuth2ClientInfo, redirect_uri: str) -> str:
             f"&response_type=code")
 
 
-def exchange_code_for_access_token(client_info: OAuth2ClientInfo, redirect_uri: str, code: str,
-                                   access_token_field: str = "access_token") -> str:
+def exchange_code_for_response(
+        client_info: OAuth2ClientInfo,
+        redirect_uri: str,
+        code: str,
+) -> dict:
     """
-    Exchange a code for an access token using the endpoints from client info
+    Exchange a code for an access token using the endpoints from client info and return the entire response
 
     :param client_info: Info about oauth2 client
     :param redirect_uri: Callback URL
     :param code: Code to redeem
-    :param access_token_field: Name of the field containing the access token to use. This might differ depending on
-                               the provider you are using. For example for Auth0 you have to set this to id_token
-    :return: Extracted access token from response
+    :return: Response from OAuth2 endpoint
     """
     headers = {
         "Content-Type": "application/x-www-form-urlencoded",
@@ -88,4 +101,25 @@ def exchange_code_for_access_token(client_info: OAuth2ClientInfo, redirect_uri:
     request = urllib.request.Request(client_info.token_url, data=encoded_data, headers=headers)
     json_response = _load_json(request)
 
+    return json_response
+
+
+def exchange_code_for_access_token(
+        client_info: OAuth2ClientInfo,
+        redirect_uri: str,
+        code: str,
+        access_token_field: str = "access_token"
+) -> str:
+    """
+    Exchange a code for an access token using the endpoints from client info
+
+    :param client_info: Info about oauth2 client
+    :param redirect_uri: Callback URL
+    :param code: Code to redeem
+    :param access_token_field: Name of the field containing the access token to use. This might differ depending on
+                               the provider you are using. For example for Auth0 you have to set this to id_token
+    :return: Extracted access token from response
+    """
+    json_response = exchange_code_for_response(client_info, redirect_uri, code)
+
     return json_response.get(access_token_field)

{oauth2_cli_auth-1.2.0 → oauth2_cli_auth-1.4.0}/oauth2_cli_auth/http_server.py

@@ -1,3 +1,6 @@
+"""
+Local HTTP server logic
+"""
 from http.server import BaseHTTPRequestHandler, HTTPServer
 from string import Template
 from typing import Optional
@@ -6,6 +9,9 @@ from oauth2_cli_auth._timeout import _method_with_timeout, TimeoutException
 
 
 class CallbackPageTemplate:
+    """
+    Holder for callback page assets and template
+    """
     SUCCESS_SVG = """
     <svg xmlns="http://www.w3.org/2000/svg" width="154px" height="154px">
         <g fill="none" stroke="#22AE73" stroke-width="2">
@@ -149,6 +155,9 @@ class CallbackPageTemplate:
 
 
 class OAuthRedirectHandler(BaseHTTPRequestHandler):
+    """
+    HTTPRequest Handler that is intended to be used as oauth2 callback page
+    """
     callback_template = CallbackPageTemplate()
 
     def log_message(self, format, *args):
@@ -201,7 +210,7 @@ class OAuthCallbackHttpServer(HTTPServer):
     def callback_url(self):
         return f"http://localhost:{self.server_port}"
 
-    def wait_for_code(self, attempts: int = 3, timeout_per_attempt=10) -> Optional[int]:
+    def wait_for_code(self, attempts: int = 3, timeout_per_attempt=10) -> Optional[str]:
         """
         Wait for the server to open the callback page containing the code query parameter.
 

{oauth2_cli_auth-1.2.0 → oauth2_cli_auth-1.4.0}/oauth2_cli_auth/simplified_flow.py

@@ -1,3 +1,6 @@
+"""
+Ready to use workflows
+"""
 from oauth2_cli_auth import OAuthCallbackHttpServer, get_auth_url, exchange_code_for_access_token, OAuth2ClientInfo, \
     open_browser
 
@@ -10,6 +13,7 @@ def get_access_token_with_browser_open(client_info: OAuth2ClientInfo, server_por
     - Open the browser with the authorization URL
     - Wait for the code to arrive
     - Get access token from code
+
     :param client_info: Client Info for Oauth2 Interaction
     :param server_port: Port of the local web server to spin up
     :return: Access Token

{oauth2_cli_auth-1.2.0 → oauth2_cli_auth-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oauth2-cli-auth"
-version = "1.2.0"
+version = "1.4.0"
 description = "Authenticate against OAuth2 Provider in Python CLIs"
 authors = ["Timo Reymann <mail@timo-reymann.de>"]
 license = "MIT"
@@ -34,13 +34,14 @@ python = "^3.9"
 [[tool.poetry.source]]
 name = "testpypi"
 url = "https://test.pypi.org/legacy/"
-default = false
-secondary = false
+priority="explicit"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.3"
 coverage = "^7.3.2"
 pdoc3 = "^0.10.0"
+setuptools = "^69.5.1"
+pydoctor = "^23.9.1"
 
 [tool.coverage.run]
 omit = [".*", "*/site-packages/*", "*/*_test.py"]
@@ -51,3 +52,22 @@ fail_under = 70
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.pydoctor]
+verbose = 0
+warnings-as-errors = true
+
+intersphinx = ["https://docs.python.org/3/objects.inv"]
+docformat = "restructuredtext"
+html-output = "gh-pages"
+
+add-package = ["oauth2_cli_auth"]
+project-name = "oauth2_cli_auth"
+project-url = "https://github.com/timo-reymann/python-oauth2-cli-auth"
+privacy = [
+    "HIDDEN:oauth2_cli_auth.*_test",
+    "HIDDEN:oauth2_cli_auth.conftest"
+]
+
+theme = "base"
+template-dir = "pydoctor-theme"