edgegrid-python 2.0.5__tar.gz → 2.0.6__tar.gz

{edgegrid_python-2.0.5/edgegrid_python.egg-info → edgegrid_python-2.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edgegrid-python
-Version: 2.0.5
+Version: 2.0.6
 Summary: {OPEN} client authentication protocol for python-requests
 Home-page: https://github.com/akamai/AkamaiOPEN-edgegrid-python
 License: Apache 2.0

{edgegrid_python-2.0.5 → edgegrid_python-2.0.6}/akamai/edgegrid/__init__.py

@@ -36,6 +36,6 @@ from .edgerc import EdgeRc
 __all__ = ['EdgeGridAuth', 'EdgeRc']
 
 __title__ = 'edgegrid-python'
-__version__ = '2.0.5'
+__version__ = '2.0.6'
 __license__ = 'Apache 2.0'
 __copyright__ = 'Copyright 2026 Akamai Technologies'

edgegrid_python-2.0.6/ci/check_namespace_pkg.py

@@ -0,0 +1,33 @@
+"""
+Namespace package import test — run by ci/test_namespace_pkg.sh after both
+edgegrid-python and the temporary akamai-dummy fragment are installed.
+Requires REPO_DIR env var pointing to the edgegrid-python repo root.
+"""
+import akamai
+import akamai.dummy
+import akamai.edgegrid
+import os
+
+from akamai.dummy import SENTINEL
+from akamai.edgegrid import EdgeGridAuth, EdgeRc
+
+assert SENTINEL == "akamai.dummy is here", f"Unexpected value: {SENTINEL!r}"
+
+# Exercise real EdgeRc code — parse the sample_edgerc shipped with the package.
+sample_edgerc = os.path.join(os.environ["REPO_DIR"], "akamai", "edgegrid", "test", "sample_edgerc")
+rc = EdgeRc(sample_edgerc)
+assert rc.get("default", "host") == "xxxx-xxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx.luna.akamaiapis.net/", "EdgeRc.get failed"
+
+# Both fragments must live under the *same* namespace package object.
+# Each entry in akamai.__path__ is the `akamai/` dir from one fragment.
+# Derive expected dirs by going up one level from each sub-package's __file__.
+real_paths = [os.path.realpath(p) for p in akamai.__path__ if os.path.isdir(p)]
+
+edgegrid_frag = os.path.realpath(os.path.join(os.path.dirname(akamai.edgegrid.__file__), ".."))
+dummy_frag    = os.path.realpath(os.path.join(os.path.dirname(akamai.dummy.__file__),   ".."))
+
+assert edgegrid_frag in real_paths, f"edgegrid fragment {edgegrid_frag!r} not in {real_paths}"
+assert dummy_frag    in real_paths, f"dummy fragment {dummy_frag!r} not in {real_paths}"
+
+print(f"OK — akamai.edgegrid is reachable from {edgegrid_frag}")
+print(f"OK — akamai.dummy    is reachable from {dummy_frag}")

edgegrid_python-2.0.6/ci/coverage_report.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+"""Generate a coverage summary markdown table from Cobertura XML files.
+
+Usage:
+    python ci/coverage_report.py <version>:<path/to/cobertura.xml> ...
+
+Each positional argument is a colon-separated pair of a label (e.g. the
+Python version) and the path to a Cobertura-format XML coverage report.
+The script reads the top-level ``line-rate`` attribute from each file,
+formats it as a percentage, and prints a markdown table to stdout.
+"""
+
+import argparse
+import sys
+import xml.etree.ElementTree as ET
+
+
+def parse_line_coverage(xml_path: str) -> float:
+    """Return the top-level line coverage rate (0–1) from a Cobertura XML file."""
+    try:
+        tree = ET.parse(xml_path)  # noqa: S314 — file is a trusted CI artifact
+    except ET.ParseError as exc:
+        raise SystemExit(f"Failed to parse {xml_path!r}: {exc}") from exc
+    root = tree.getroot()
+    try:
+        return float(root.attrib["line-rate"])
+    except (KeyError, ValueError) as exc:
+        raise SystemExit(f"Missing or invalid 'line-rate' in {xml_path!r}: {exc}") from exc
+
+
+def build_table(rows: list[tuple[str, float]]) -> str:
+    lines = [
+        "## Coverage Report",
+        "",
+        "| Python Version | Line Coverage |",
+        "| :---: | :---: |",
+    ]
+    for version, rate in sorted(rows):
+        pct = rate * 100
+        badge = "✅" if pct >= 80 else "❌"
+        lines.append(f"| {version} | {badge} {pct:.1f}% |")
+    return "\n".join(lines) + "\n"
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(
+        description="Summarise Cobertura coverage reports into a GitHub step summary."
+    )
+    parser.add_argument(
+        "entries",
+        nargs="+",
+        metavar="VERSION:XML_PATH",
+        help="Colon-separated pair of a label and the path to a Cobertura XML file.",
+    )
+    args = parser.parse_args()
+
+    rows: list[tuple[str, float]] = []
+    for entry in args.entries:
+        if ":" not in entry:
+            print(f"Error: expected VERSION:PATH, got {entry!r}", file=sys.stderr)
+            sys.exit(1)
+        version, xml_path = entry.split(":", 1)
+        rate = parse_line_coverage(xml_path)
+        rows.append((version, rate))
+
+    table = build_table(rows)
+    print(table)
+
+
+if __name__ == "__main__":
+    main()

{edgegrid_python-2.0.5 → edgegrid_python-2.0.6/edgegrid_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edgegrid-python
-Version: 2.0.5
+Version: 2.0.6
 Summary: {OPEN} client authentication protocol for python-requests
 Home-page: https://github.com/akamai/AkamaiOPEN-edgegrid-python
 License: Apache 2.0

{edgegrid_python-2.0.5 → edgegrid_python-2.0.6}/edgegrid_python.egg-info/SOURCES.txt

@@ -3,7 +3,6 @@ MANIFEST.in
 README.md
 requirements.txt
 setup.py
-akamai/__init__.py
 akamai/edgegrid/__init__.py
 akamai/edgegrid/edgegrid.py
 akamai/edgegrid/edgerc.py
@@ -15,9 +14,14 @@ akamai/edgegrid/test/sample_file.txt
 akamai/edgegrid/test/test_edgegrid.py
 akamai/edgegrid/test/testcases.json
 akamai/edgegrid/test/testdata.json
+ci/check_namespace_pkg.py
+ci/coverage_report.py
 edgegrid_python.egg-info/PKG-INFO
 edgegrid_python.egg-info/SOURCES.txt
 edgegrid_python.egg-info/dependency_links.txt
-edgegrid_python.egg-info/namespace_packages.txt
 edgegrid_python.egg-info/requires.txt
-edgegrid_python.egg-info/top_level.txt
+edgegrid_python.egg-info/top_level.txt
+examples/create-credentials.py
+examples/delete-credentials.py
+examples/get-credentials.py
+examples/update-credentials.py

edgegrid_python-2.0.6/edgegrid_python.egg-info/top_level.txt

@@ -0,0 +1,4 @@
+akamai
+build
+ci
+examples

edgegrid_python-2.0.6/examples/create-credentials.py

@@ -0,0 +1,34 @@
+# This example creates your new API client credentials.
+#
+# To run this example:
+#
+# 1. Specify the location of your .edgerc file and the section header of the set of credentials to use.
+#
+## The defaults here expect the .edgerc at your home directory and use the credentials under the heading of default.
+#
+# 2. Open a Terminal or shell instance and run "python examples/create-credentials.py".
+#
+# A successful call returns a new API client with its credentialId. Use this ID in both the update and delete examples.
+#
+# For more information on the call used in this example, see https://techdocs.akamai.com/iam-api/reference/post-self-credentials.
+
+import requests
+import json
+from akamai.edgegrid import EdgeGridAuth, EdgeRc
+from urllib.parse import urljoin
+
+edgerc = EdgeRc('~/.edgerc')
+section = 'default'
+baseurl = 'https://%s' % edgerc.get(section, 'host')
+
+session = requests.Session()
+session.auth = EdgeGridAuth.from_edgerc(edgerc, section)
+
+path = '/identity-management/v3/api-clients/self/credentials'
+headers = {
+  "Accept": "application/json"
+}
+
+result = session.post(urljoin(baseurl, path), headers=headers)
+print(result.status_code)
+print(json.dumps(result.json(), indent=2))

edgegrid_python-2.0.6/examples/delete-credentials.py

@@ -0,0 +1,35 @@
+# This example deletes your API client credentials.
+#
+# To run this example:
+#
+# 1. Specify the location of your .edgerc file and the section header of the set of credentials to use.
+#
+# The defaults here expect the .edgerc at your home directory and use the credentials under the heading of default.
+#
+# 2. Add the credentialId from the update example to the path. You can only delete inactive credentials. Sending the request on an active set will return a 400. Use the update credentials example for deactivation.
+#
+# **Important:** Don't use the credentials you're actively using when deleting a set of credentials. Otherwise, you'll block your access to the Akamai APIs.
+#
+# 3. Open a Terminal or shell instance and run "python examples/delete-credentials.py".
+#
+# A successful call returns "" null.
+#
+# For more information on the call used in this example, see https://techdocs.akamai.com/iam-api/reference/delete-self-credential.
+
+import requests
+import json
+from akamai.edgegrid import EdgeGridAuth, EdgeRc
+from urllib.parse import urljoin
+
+edgerc = EdgeRc('~/.edgerc')
+section = 'default'
+baseurl = 'https://%s' % edgerc.get(section, 'host')
+
+session = requests.Session()
+session.auth = EdgeGridAuth.from_edgerc(edgerc, section)
+credentialId = 123456
+
+path = '/identity-management/v3/api-clients/self/credentials/{}'.format(credentialId)
+
+result = session.delete(urljoin(baseurl, path))
+print(result.status_code)

edgegrid_python-2.0.6/examples/get-credentials.py

@@ -0,0 +1,37 @@
+# This example returns a list of your API client credentials.
+#
+# To run this example:
+#
+# 1. Specify the location of your .edgerc file and the section header of the set of credentials to use.
+#
+# The defaults here expect the .edgerc at your home directory and use the credentials under the heading of default.
+#
+# 2. Open a Terminal or shell instance and run "python examples/get-credentials.py".
+#
+# A successful call returns your credentials grouped by credentialId.
+#
+# For more information on the call used in this example, see https://techdocs.akamai.com/iam-api/reference/get-self-credentials.
+
+import requests
+import json
+from akamai.edgegrid import EdgeGridAuth, EdgeRc
+from urllib.parse import urljoin
+
+edgerc = EdgeRc('~/.edgerc')
+section = 'default'
+baseurl = 'https://%s' % edgerc.get(section, 'host')
+
+session = requests.Session()
+session.auth = EdgeGridAuth.from_edgerc(edgerc, section)
+
+path = '/identity-management/v3/api-clients/self/credentials'
+headers = {
+  "Accept": "application/json"}
+querystring = {
+  "actions": True
+}
+
+result = session.get(urljoin(baseurl, path), headers=headers, params=querystring)
+print(result.status_code)
+print(json.dumps(result.json(), indent=2))
+

edgegrid_python-2.0.6/examples/update-credentials.py

@@ -0,0 +1,47 @@
+# This example updates the credentials from the create credentials example.
+#
+# To run this example:
+#
+# 1. Specify the location of your .edgerc file and the section header of the set of credentials to use.
+#
+# The defaults here expect the .edgerc at your home directory and use the credentials under the heading of default.
+#
+# 2. Add the credentialId for the set of credentials created using the create example as a path parameter.
+#
+# 3. Edit the expiresOn date to today's date. Optionally, you can change the description value.
+#
+# **Important:** Don't use the credentials you're actively using when inactivating a set of credentials. Otherwise, you'll block your access to the Akamai APIs.
+#
+# 4. Open a Terminal or shell instance and run "python examples/update-credentials.py".
+#
+# A successful call returns.
+#
+# For more information on the call used in this example, see https://techdocs.akamai.com/iam-api/reference/put-self-credential.
+
+import requests
+import json
+from akamai.edgegrid import EdgeGridAuth, EdgeRc
+from urllib.parse import urljoin
+
+edgerc = EdgeRc('~/.edgerc')
+section = 'default'
+baseurl = 'https://%s' % edgerc.get(section, 'host')
+
+session = requests.Session()
+session.auth = EdgeGridAuth.from_edgerc(edgerc, section)
+credentialId = 123456
+
+path = '/identity-management/v3/api-clients/self/credentials/{}'.format(credentialId)
+headers = {
+  "Content-Type": "application/json",
+  "Accept": "application/json"}
+payload = {
+    "status": "INACTIVE",
+    "expiresOn": "2024-12-30T22:09:24.000Z", # The date cannot be more than two years out or it will return a 400
+    "description": "Update this credential"
+}
+
+result = session.put(urljoin(baseurl, path), headers=headers, json=payload)
+print(result.status_code)
+print(json.dumps(result.json(), indent=2))
+

{edgegrid_python-2.0.5 → edgegrid_python-2.0.6}/requirements.txt

@@ -10,7 +10,7 @@ charset-normalizer==3.4.4
     # via requests
 idna==3.11
     # via requests
-requests==2.32.5
+requests==2.33.0
     # via
     #   edgegrid-python (setup.py)
     #   requests-toolbelt

{edgegrid_python-2.0.5 → edgegrid_python-2.0.6}/setup.py

@@ -1,12 +1,12 @@
-from setuptools import setup, find_packages
+from setuptools import setup, find_namespace_packages
+
 
 setup(
     name='edgegrid-python',
-    version='2.0.5',
+    version='2.0.6',
     description='{OPEN} client authentication protocol for python-requests',
     url='https://github.com/akamai/AkamaiOPEN-edgegrid-python',
-    namespace_packages=['akamai'],
-    packages=find_packages(),
+    packages=find_namespace_packages(),
     python_requires=">=3.10",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",

edgegrid_python-2.0.5/akamai/__init__.py

@@ -1,2 +0,0 @@
-"""Library provides an authentication handler for requests"""
-__import__('pkg_resources').declare_namespace(__name__)

edgegrid_python-2.0.5/edgegrid_python.egg-info/namespace_packages.txt

@@ -1 +0,0 @@
-akamai

edgegrid_python-2.0.5/edgegrid_python.egg-info/top_level.txt

@@ -1 +0,0 @@
-akamai