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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-postman
-Version: 0.8.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,6 +25,7 @@ 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'
@@ -33,22 +34,21 @@ 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: httpx>=0.25.0; 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
-- **Script Execution**: Run pre-request and test scripts with result collection
 - **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
@@ -95,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}")
@@ -106,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}")
 
@@ -119,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
@@ -181,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")
 ```
@@ -189,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
@@ -312,6 +320,12 @@ async def execute_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()
@@ -458,21 +472,6 @@ except RequestExecutionError as e:
     print(f"Execution error: {e}")
 ```
 
-### Test Scripts and Results
-
-```python
-# Test results are automatically collected from test scripts
-result = await executor.execute_request(request, context)
-
-if result.test_results:
-    print(f"Tests: {result.test_results.passed} passed, {result.test_results.failed} failed")
-
-    # Check individual assertions
-    for assertion in result.test_results.assertions:
-        if not assertion.passed:
-            print(f"Failed: {assertion.name} - {assertion.error}")
-```
-
 ## API Reference
 
 ### Main Classes
@@ -483,7 +482,7 @@ if result.test_results:
 - **`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
 

{python_postman-0.8.0 → python_postman-0.9.0}/README.md

@@ -1,16 +1,15 @@
-# 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
-- **Script Execution**: Run pre-request and test scripts with result collection
 - **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
@@ -57,9 +56,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}")
@@ -68,8 +71,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}")
 
@@ -81,11 +92,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
@@ -143,7 +149,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")
 ```
@@ -151,18 +157,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
@@ -274,6 +281,12 @@ async def execute_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()
@@ -420,21 +433,6 @@ except RequestExecutionError as e:
     print(f"Execution error: {e}")
 ```
 
-### Test Scripts and Results
-
-```python
-# Test results are automatically collected from test scripts
-result = await executor.execute_request(request, context)
-
-if result.test_results:
-    print(f"Tests: {result.test_results.passed} passed, {result.test_results.failed} failed")
-
-    # Check individual assertions
-    for assertion in result.test_results.assertions:
-        if not assertion.passed:
-            print(f"Failed: {assertion.name} - {assertion.error}")
-```
-
 ## API Reference
 
 ### Main Classes
@@ -445,7 +443,7 @@ if result.test_results:
 - **`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