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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oauth2-cli-auth
-Version: 1.3.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

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

@@ -1,3 +1,6 @@
+"""
+Functionality to work with OAuth2 code grant
+"""
 import base64
 import urllib.parse
 import urllib.request
@@ -34,6 +37,11 @@ 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
 
@@ -76,8 +84,6 @@ def exchange_code_for_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: Response from OAuth2 endpoint
     """
     headers = {

{oauth2_cli_auth-1.3.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):

{oauth2_cli_auth-1.3.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.3.0 → oauth2_cli_auth-1.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oauth2-cli-auth"
-version = "1.3.0"
+version = "1.4.0"
 description = "Authenticate against OAuth2 Provider in Python CLIs"
 authors = ["Timo Reymann <mail@timo-reymann.de>"]
 license = "MIT"
@@ -40,6 +40,8 @@ priority="explicit"
 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"]
@@ -50,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"