python-postman 0.7.0__tar.gz → 0.9.0__tar.gz

{python_postman-0.7.0 → python_postman-0.9.0}/.github/workflows/python-publish.yml

@@ -1,65 +1,65 @@
-# This workflow will upload a Python Package to PyPI when a release is published
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
-
-name: Publish Python Package to PyPI
-
-on:
-  release:
-    types: [published]
-
-permissions:
-  contents: read
-
-jobs:
-  build:
-    name: Build distribution 📦
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v5
-
-      - name: Set up Python
-        uses: actions/setup-python@v6
-        with:
-          python-version: "3.x"
-          cache: pip  # Cache pip dependencies for faster runs
-
-      - name: Install build dependencies
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install build
-
-      - name: Build package
-        run: python -m build
-
-      - name: Verify build artifacts
-        run: |
-          ls -la dist/
-          python -m pip install twine
-          python -m twine check dist/*
-
-      - name: Store the distribution packages
-        uses: actions/upload-artifact@v4
-        with:
-          name: python-package-distributions
-          path: dist/
-
-  publish-to-pypi:
-    name: Publish Python 🐍 distribution 📦 to PyPI
-    needs: [build]
-    runs-on: ubuntu-latest
-    environment:
-      name: pypi
-      url: https://pypi.org/p/${{ github.event.repository.name }}
-    permissions:
-      id-token: write  # IMPORTANT: mandatory for trusted publishing
-
-    steps:
-      - name: Download all the dists
-        uses: actions/download-artifact@v4
-        with:
-          name: python-package-distributions
-          path: dist/
-
-      - name: Publish distribution 📦 to PyPI
+# This workflow will upload a Python Package to PyPI when a release is published
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+name: Publish Python Package to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+          cache: pip  # Cache pip dependencies for faster runs
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Verify build artifacts
+        run: |
+          ls -la dist/
+          python -m pip install twine
+          python -m twine check dist/*
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish Python 🐍 distribution 📦 to PyPI
+    needs: [build]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/${{ github.event.repository.name }}
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distribution 📦 to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

{python_postman-0.7.0 → python_postman-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-postman
-Version: 0.7.0
+Version: 0.9.0
 Summary: A Python library for parsing and working with Postman collection.json files
 Project-URL: Homepage, https://github.com/python-postman/python-postman
 Project-URL: Repository, https://github.com/python-postman/python-postman
@@ -25,23 +25,31 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Testing
 Requires-Python: >=3.9
+Requires-Dist: httpx>=0.28.1
 Provides-Extra: dev
 Requires-Dist: black>=23.0.0; extra == 'dev'
 Requires-Dist: isort>=5.12.0; extra == 'dev'
 Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
 Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
 Requires-Dist: pytest>=8.4.2; extra == 'dev'
+Provides-Extra: execution
+Requires-Dist: python-dotenv>=1.0.0; extra == 'execution'
 Description-Content-Type: text/markdown
 
-# Python Postman Collection Parser
+# Python Postman
 
-A Python library for parsing and working with Postman collection.json files. This library provides a clean, object-oriented interface for reading Postman collections and accessing their components programmatically.
+A comprehensive Python library for working with Postman collections. Parse, execute, search, and analyze Postman collection.json files with a clean, object-oriented interface. Execute HTTP requests with full async/sync support, dynamic variable resolution, and authentication handling.
 
 ## Features
 
 - **Parse Postman Collections**: Load collections from files, JSON strings, or dictionaries
 - **Object-Oriented API**: Work with collections using intuitive Python objects
-- **Full Collection Support**: Access requests, folders, variables, authentication, and scripts
+- **Full Collection Support**: Access requests, folders, variables, authentication, and events
+- **HTTP Request Execution**: Execute requests using httpx with full async/sync support
+- **Variable Resolution**: Dynamic variable substitution with proper scoping
+- **Authentication Handling**: Automatic auth processing for Bearer, Basic, and API Key
+- **Request Extensions**: Runtime modification of URLs, headers, body, and auth
 - **Validation**: Built-in validation for collection structure and schema compliance
 - **Iteration**: Easy iteration through all requests regardless of folder structure
 - **Search**: Find requests and folders by name
@@ -50,7 +58,13 @@ A Python library for parsing and working with Postman collection.json files. Thi
 ## Installation
 
 ```bash
+# Basic installation (parsing only)
 pip install python-postman
+
+# With HTTP execution support
+pip install python-postman[execution]
+# or
+pip install python-postman httpx
 ```
 
 ## Quick Start
@@ -81,9 +95,13 @@ print(f"Description: {collection.info.description}")
 print(f"Schema: {collection.info.schema}")
 
 # Collection-level variables
-for variable in collection.variables:
+for variable in collection.variables: # This requests a list of Variable objects
     print(f"Variable: {variable.key} = {variable.value}")
 
+# Collection variables dictionary. This is a quick way to get key-value pairs.
+# You can pass/update these and add them to the execution context.
+collection_variables = collection.get_variables()
+
 # Collection-level authentication
 if collection.auth:
     print(f"Auth Type: {collection.auth.type}")
@@ -92,8 +110,16 @@ if collection.auth:
 ### Working with Requests
 
 ```python
+# Get a list of requests by name
+collection.list_requests()
+
+# Find specific request by name
+login_request = collection.get_request_by_name("Login Request")
+if login_request:
+    print(f"Found request: {login_request.method} {login_request.url}")
+
 # Iterate through all requests (flattens folder structure)
-for request in collection.get_all_requests():
+for request in collection.get_requests():
     print(f"Request: {request.method} {request.name}")
     print(f"URL: {request.url}")
 
@@ -105,11 +131,6 @@ for request in collection.get_all_requests():
     if request.body:
         print(f"Body Type: {request.body.mode}")
         print(f"Body Content: {request.body.raw}")
-
-# Find specific request by name
-request = collection.get_request_by_name("Login Request")
-if request:
-    print(f"Found request: {request.method} {request.url}")
 ```
 
 ### Working with Folders
@@ -167,7 +188,7 @@ if collection.auth:
         print(f"Basic Auth Username: {username}")
 
 # Request-level auth (overrides collection auth)
-for request in collection.get_all_requests():
+for request in collection.get_requests():
     if request.auth:
         print(f"Request '{request.name}' has {request.auth.type} auth")
 ```
@@ -175,18 +196,19 @@ for request in collection.get_all_requests():
 ### Events (Scripts)
 
 ```python
-# Collection-level events
+# Access script content from collection-level events
 for event in collection.events:
     print(f"Collection Event: {event.listen}")
-    print(f"Script: {event.script}")
+    print(f"Script Content: {event.script}")
 
-# Request-level events
-for request in collection.get_all_requests():
+# Access script content from request-level events
+# Note: JavaScript execution is not supported - scripts are accessible as text only
+for request in collection.get_requests():
     for event in request.events:
         if event.listen == "prerequest":
-            print(f"Pre-request script for {request.name}")
+            print(f"Pre-request script for {request.name}: {event.script}")
         elif event.listen == "test":
-            print(f"Test script for {request.name}")
+            print(f"Test script for {request.name}: {event.script}")
 ```
 
 ### Validation
@@ -219,6 +241,237 @@ collection = PythonPostman.create_collection(
 print(f"Created collection: {collection.info.name}")
 ```
 
+## HTTP Request Execution
+
+The library supports executing HTTP requests from Postman collections using httpx. This feature requires the `httpx` dependency.
+
+### Basic Request Execution
+
+```python
+import asyncio
+from python_postman import PythonPostman
+from python_postman.execution import RequestExecutor, ExecutionContext
+
+async def main():
+    # Load collection
+    collection = PythonPostman.from_file("api_collection.json")
+
+    # Create executor
+    executor = RequestExecutor(
+        client_config={"timeout": 30.0, "verify": True},
+        global_headers={"User-Agent": "python-postman/1.0"}
+    )
+
+    # Create execution context with variables
+    context = ExecutionContext(
+        environment_variables={
+            "base_url": "https://api.example.com",
+            "api_key": "your-api-key"
+        }
+    )
+
+    # Execute a single request
+    request = collection.get_request_by_name("Get Users")
+    result = await executor.execute_request(request, context)
+
+    if result.success:
+        print(f"Status: {result.response.status_code}")
+        print(f"Response: {result.response.json}")
+        print(f"Time: {result.response.elapsed_ms:.2f}ms")
+    else:
+        print(f"Error: {result.error}")
+
+    await executor.aclose()
+
+asyncio.run(main())
+```
+
+### Synchronous Execution
+
+```python
+from python_postman.execution import RequestExecutor, ExecutionContext
+
+# Synchronous execution
+with RequestExecutor() as executor:
+    context = ExecutionContext(
+        environment_variables={"base_url": "https://httpbin.org"}
+    )
+
+    result = executor.execute_request_sync(request, context)
+    if result.success:
+        print(f"Status: {result.response.status_code}")
+```
+
+### Collection Execution
+
+```python
+# Execute entire collection
+async def execute_collection():
+    executor = RequestExecutor()
+
+    # Sequential execution
+    result = await executor.execute_collection(collection)
+    print(f"Executed {result.total_requests} requests")
+    print(f"Success rate: {result.successful_requests}/{result.total_requests}")
+
+    # Parallel execution
+    result = await executor.execute_collection(
+        collection,
+        parallel=True,
+        stop_on_error=False
+    )
+
+    # Get the request responses
+    for result in result.results:
+        print(f"Request: {result.request.name}")
+        print(f"Result Text: {result.response.text}")
+
+    print(f"Parallel execution completed in {result.total_time_ms:.2f}ms")
+
+    await executor.aclose()
+```
+
+### Variable Management
+
+```python
+# Variable scoping: request > folder > collection > environment
+context = ExecutionContext(
+    environment_variables={"env": "production"},
+    collection_variables={"api_version": "v1", "timeout": "30"},
+    folder_variables={"endpoint": "/users"},
+    request_variables={"user_id": "12345"}
+)
+
+# Variables are resolved with proper precedence
+url = context.resolve_variables("{{base_url}}/{{api_version}}{{endpoint}}/{{user_id}}")
+print(url)  # "https://api.example.com/v1/users/12345"
+
+# Dynamic variable updates
+context.set_variable("session_token", "abc123", "environment")
+```
+
+### Path Parameters
+
+The library supports both Postman-style variables (`{{variable}}`) and path parameters (`:parameter`):
+
+```python
+# Path parameters use :parameterName syntax
+context = ExecutionContext(
+    environment_variables={
+        "baseURL": "https://api.example.com",
+        "userId": "12345",
+        "datasetId": "abc123"
+    }
+)
+
+# Mix Postman variables and path parameters
+url = context.resolve_variables("{{baseURL}}/users/:userId/datasets/:datasetId")
+print(url)  # "https://api.example.com/users/12345/datasets/abc123"
+
+# Path parameters follow the same scoping rules as Postman variables
+url = context.resolve_variables("{{baseURL}}/:datasetId?$offset=0&$limit=10")
+print(url)  # "https://api.example.com/abc123?$offset=0&$limit=10"
+```
+
+### Request Extensions
+
+```python
+from python_postman.execution import RequestExtensions
+
+# Runtime request modifications
+extensions = RequestExtensions(
+    # Substitute existing values
+    header_substitutions={"Authorization": "Bearer {{new_token}}"},
+    url_substitutions={"host": "staging.api.example.com"},
+
+    # Add new values
+    header_extensions={"X-Request-ID": "req-{{timestamp}}"},
+    param_extensions={"debug": "true", "version": "v2"},
+    body_extensions={"metadata": {"client": "python-postman"}}
+)
+
+result = await executor.execute_request(
+    request,
+    context,
+    extensions=extensions
+)
+```
+
+### Authentication
+
+```python
+# Authentication is handled automatically based on collection/request auth settings
+
+# Bearer Token
+context = ExecutionContext(
+    environment_variables={"bearer_token": "eyJhbGciOiJIUzI1NiIs..."}
+)
+
+# Basic Auth
+context = ExecutionContext(
+    environment_variables={
+        "username": "admin",
+        "password": "secret123"
+    }
+)
+
+# API Key
+context = ExecutionContext(
+    environment_variables={"api_key": "sk-1234567890abcdef"}
+)
+
+# Auth is applied automatically during request execution
+result = await executor.execute_request(request, context)
+```
+
+### Request Methods on Models
+
+```python
+# Execute requests directly from Request objects
+request = collection.get_request_by_name("Health Check")
+
+# Async execution
+result = await request.execute(
+    executor=executor,
+    context=context,
+    substitutions={"env": "staging"}
+)
+
+# Sync execution
+result = request.execute_sync(
+    executor=executor,
+    context=context
+)
+
+# Execute collections directly
+result = await collection.execute(
+    executor=executor,
+    parallel=True
+)
+```
+
+### Error Handling
+
+```python
+from python_postman.execution import (
+    ExecutionError,
+    RequestExecutionError,
+    VariableResolutionError,
+    AuthenticationError
+)
+
+try:
+    result = await executor.execute_request(request, context)
+    if not result.success:
+        print(f"Request failed: {result.error}")
+except VariableResolutionError as e:
+    print(f"Variable error: {e}")
+except AuthenticationError as e:
+    print(f"Auth error: {e}")
+except RequestExecutionError as e:
+    print(f"Execution error: {e}")
+```
+
 ## API Reference
 
 ### Main Classes
@@ -229,7 +482,7 @@ print(f"Created collection: {collection.info.name}")
 - **`Folder`**: Container for organizing requests and sub-folders
 - **`Variable`**: Collection, folder, or request-level variables
 - **`Auth`**: Authentication configuration
-- **`Event`**: Pre-request scripts and test scripts
+- **`Event`**: Pre-request and test script definitions (text only, execution not supported)
 
 ### Exception Handling
 
@@ -316,9 +569,9 @@ This project is licensed under the MIT License - see the LICENSE file for detail
 
 ## Changelog
 
-### 0.7.0 (Updated version)
+### 0.8.0 (Updated version)
 
-- Updated version to 0.7.0
+- Updated version to 0.8.0
 - Updated README.md
 - Updated pyproject.toml
 - Updated tests