http-api-tool 0.1.1__tar.gz

http_api_tool-0.1.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

http_api_tool-0.1.1/PKG-INFO

@@ -0,0 +1,504 @@
+Metadata-Version: 2.1
+Name: http-api-tool
+Version: 0.1.1
+Summary: A Python HTTP/HTTPS API testing tool for GitHub Actions and CLI usage
+Keywords: http,api,testing,verification,github-actions,curl,monitoring,health-check
+Author-Email: Matthew Watkins <93649628+ModeSevenIndustrialSolutions@users.noreply.github.com>
+Maintainer-Email: Matthew Watkins <93649628+ModeSevenIndustrialSolutions@users.noreply.github.com>
+License: Apache-2.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: System :: Monitoring
+Classifier: Topic :: Utilities
+Project-URL: Homepage, https://github.com/lfreleng-actions/http-api-tool-docker
+Project-URL: Repository, https://github.com/lfreleng-actions/http-api-tool-docker
+Project-URL: Documentation, https://github.com/lfreleng-actions/http-api-tool-docker/blob/main/README.md
+Project-URL: Bug Tracker, https://github.com/lfreleng-actions/http-api-tool-docker/issues
+Requires-Python: >=3.10
+Requires-Dist: pycurl>=7.45.0
+Requires-Dist: typer[all]>=0.9.0
+Requires-Dist: certifi>=2025.6.15
+Requires-Dist: requests>=2.32.4
+Provides-Extra: test
+Requires-Dist: pytest>=8.0.0; extra == "test"
+Requires-Dist: pytest-cov>=6.2.1; extra == "test"
+Requires-Dist: requests>=2.32.4; extra == "test"
+Requires-Dist: responses>=0.25.0; extra == "test"
+Requires-Dist: coverage[toml]>=7.9.1; extra == "test"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=6.2.1; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: isort>=5.13.0; extra == "dev"
+Requires-Dist: flake8>=7.0.0; extra == "dev"
+Requires-Dist: bandit>=1.8.0; extra == "dev"
+Requires-Dist: pre-commit>=4.0.0; extra == "dev"
+Requires-Dist: mypy>=1.11.0; extra == "dev"
+Requires-Dist: coverage[toml]>=7.9.1; extra == "dev"
+Description-Content-Type: text/markdown
+
+<!--
+SPDX-License-Identifier: Apache-2.0
+SPDX-FileCopyrightText: 2025 The Linux Foundation
+-->
+
+# HTTP API Test Tool
+
+An HTTP API testing tool for GitHub Actions and command-line usage.
+
+This action performs HTTP requests with configurable verification of response
+status, content, headers, and timing. Implemented in Python to modern PEP
+standards, using Typer and pycurl. Avoids JSON escaping issues associated with
+shell code implementations in GitHub actions.
+
+## http-api-tool-docker
+
+A containerized version of the HTTP API test tool with secure,
+multi-architecture support.
+
+### Docker Security Features
+
+The Dockerfile implements these security best practices:
+
+- **Version Pinning**: uv binary version is explicitly pinned (0.8.4)
+- **Checksum Validation**: Downloads verify against SHA256 checksums to
+  prevent MITM attacks
+- **Multi-Architecture Support**: Automatically detects and downloads the
+  correct binary for:
+  - `linux/amd64` (Intel/AMD x86_64)
+  - `linux/arm64` (Apple Silicon/ARM64)
+
+### Building the Container
+
+```bash
+# Build for current platform
+docker build -t http-api-tool .
+
+# Build for specific platform
+docker build --platform linux/amd64 -t http-api-tool .
+docker build --platform linux/arm64 -t http-api-tool .
+
+# Override uv version
+docker build --build-arg UV_VERSION=0.8.5 -t http-api-tool .
+```
+
+### Container Usage
+
+```bash
+# Run the tool
+docker run --rm http-api-tool --help
+
+# Check uv version in container
+docker run --rm --entrypoint=/usr/local/bin/uv http-api-tool --version
+```
+
+## Features
+
+- **Supported HTTP Methods**: Supports GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
+- **Authentication**: Basic Auth via auth_string and custom headers support
+- **Response Validation**: Status code, regex pattern matching, response time limits
+- **Retry Logic**: Configurable exponential backoff with jitter
+- **Dual Usage**: Works as both a CLI tool and GitHub Action
+- **Robust Error Handling**: Detailed error messages and proper exit codes
+- **JSON Safety**: Uses pycurl instead of shell commands to avoid escaping issues
+- **SSL/TLS Support**: Full SSL verification with custom CA bundle support
+- **Response Metrics**: Comprehensive timing and size measurements
+
+## Usage
+
+### As a GitHub Action
+
+```yaml
+- name: Test API Endpoint
+  uses: lfreleng-actions/http-api-tool-docker@main
+  with:
+    url: 'https://api.example.com/health'
+    http_method: 'GET'
+    expected_http_code: '200'
+    curl_timeout: '30'
+    max_response_time: '10'
+    retries: '3'
+    initial_sleep_time: '2'
+
+# Example with custom CA certificate
+- name: Test API with Custom CA
+  uses: lfreleng-actions/http-api-tool-docker@main
+  with:
+    url: 'https://internal-api.company.com/health'
+    ca_bundle_path: '/path/to/ca-certificates.pem'
+    expected_http_code: '200'
+```
+
+### As a CLI Tool
+
+```bash
+# Install PDM (if not already installed)
+pip install --no-cache-dir pdm==2.24.2
+
+# Install dependencies using PDM with hash verification
+pdm install
+
+# Basic usage
+pdm run python -m http_api_tool test --url https://api.example.com/health
+
+# Advanced usage
+pdm run python -m http_api_tool test \
+  --url https://api.example.com/users \
+  --http-method POST \
+  --request-body '{"name": "John", "email": "john@example.com"}' \
+  --request-headers '{"Content-Type": "application/json"}' \
+  --auth-string username:password \
+  --expected-http-code 201 \
+  --regex '"id":\s*\d+' \
+  --curl-timeout 30 \
+  --max-response-time 10 \
+  --retries 3
+```
+
+## Inputs
+
+<!-- markdownlint-disable MD013 -->
+
+| Input | Description | Required | Default |
+|-------|-------------|----------|---------|
+| `url` | URL of API server/interface to check | Yes | - |
+| `auth_string` | Authentication string, colon separated username/password | No | - |
+| `service_name` | Name of HTTP/HTTPS API service tested | No | `API Service` |
+| `initial_sleep_time` | Time in seconds between API service connection attempts | No | `1` |
+| `max_delay` | Max delay in seconds between retries | No | `30` |
+| `retries` | Number of retries before declaring service unavailable | No | `3` |
+| `expected_http_code` | HTTP response code to accept from the API service | No | `200` |
+| `regex` | Verify server response with regular expression | No | - |
+| `show_header_json` | Display response header as JSON in action output | No | `false` |
+| `curl_timeout` | Max time in seconds for cURL to wait for a response | No | `5` |
+| `http_method` | HTTP method to use (GET, POST, PUT, etc.) | No | `GET` |
+| `request_body` | Data to send with POST/PUT/PATCH requests | No | - |
+| `content_type` | Content type for the request body | No | `application/json` |
+| `request_headers` | Custom HTTP headers sent in JSON format | No | - |
+| `verify_ssl` | Verify SSL certificates | No | `true` |
+| `ca_bundle_path` | Path to CA bundle file for SSL verification | No | - |
+| `include_response_body` | Include response body in outputs (base64) | No | `false` |
+| `follow_redirects` | Follow HTTP redirects | No | `true` |
+| `max_response_time` | Max acceptable response time in seconds | No | `0` |
+| `connection_reuse` | Reuse connections between requests | No | `true` |
+| `debug` | Enables debugging output | No | `false` |
+| `fail_on_timeout` | Fail if response time exceeds max_response_time | No | `false` |
+
+<!-- markdownlint-enable MD013 -->
+
+## Outputs
+
+| Output | Description |
+|--------|-------------|
+| `time_delay` | Number of seconds waiting for service availability/failure |
+| `response_http_code` | HTTP response code received from the server |
+| `response_header_json` | HTTP response header as JSON |
+| `response_header_size` | HTTP response header size in bytes |
+| `response_body_size` | HTTP response body size in bytes |
+| `regex_match` | Whether the regular expression matched the server reply |
+| `response_body_base64` | Response body base64 encoded (when enabled) |
+| `total_time` | Total time for the request in seconds |
+| `connect_time` | Time to establish connection in seconds |
+| `response_time_exceeded` | Whether response time exceeded max time |
+
+## Authentication
+
+### Authentication String
+
+```yaml
+with:
+  auth_string: 'username:password'
+```
+
+### Custom Headers
+
+```yaml
+with:
+  request_headers: |
+    {
+      "Authorization": "Bearer your-jwt-token",
+      "X-API-Key": "your-api-key",
+      "X-Custom-Header": "value"
+    }
+```
+
+## Examples
+
+### Simple Health Check
+
+```yaml
+- name: Health Check
+  uses: lfreleng-actions/http-api-tool-docker@main
+  with:
+    url: 'https://api.example.com/health'
+    expected_http_code: '200'
+```
+
+### POST with JSON Data
+
+```yaml
+- name: Create User
+  uses: lfreleng-actions/http-api-tool-docker@main
+  with:
+    url: 'https://api.example.com/users'
+    http_method: 'POST'
+    request_headers: '{"Content-Type": "application/json"}'
+    request_body: '{"name": "John Doe", "email": "john@example.com"}'
+    expected_http_code: '201'
+    regex: '"id":\s*\d+'
+```
+
+### Authenticated Request with Retry
+
+```yaml
+- name: Get Protected Resource
+  uses: lfreleng-actions/http-api-tool-docker@main
+  with:
+    url: 'https://api.example.com/protected'
+    request_headers: '{"Authorization": "Bearer ${{ secrets.API_TOKEN }}"}'
+    retries: '5'
+    initial_sleep_time: '2'
+    curl_timeout: '30'
+```
+
+### Response Validation
+
+```yaml
+- name: Test API Response
+  uses: lfreleng-actions/http-api-tool-docker@main
+  with:
+    url: 'https://api.example.com/status'
+    regex: '"status":\s*"ok"'
+    max_response_time: '5'
+```
+
+## Error Handling
+
+The action provides detailed error messages for common scenarios:
+
+- **Connection Errors**: Network connectivity issues
+- **Timeout Errors**: Request or connection timeouts
+- **Authentication Errors**: Invalid credentials
+- **Validation Errors**: Unexpected status codes or response patterns
+- **SSL Errors**: Certificate verification failures
+
+## Development
+
+### Running Tests
+
+```bash
+# Install PDM (if not already installed)
+pip install --no-cache-dir pdm==2.24.2
+
+# Install development dependencies with hash verification
+pdm install --dev
+
+# Run tests
+pdm run pytest tests/ -v
+
+# Run with coverage
+pdm run pytest tests/ --cov=http_api_tool --cov-report=html
+```
+
+### Pre-commit Hooks
+
+```bash
+# Install pre-commit (included in dev dependencies)
+pdm install --dev
+
+# Install hooks
+pdm run pre-commit install
+
+# Run hooks manually
+pdm run pre-commit run --all-files
+```
+
+### Docker Requirements Management
+
+The Docker image uses a **dynamic requirements generation** approach where the
+Docker build process generates the `requirements-docker.txt` file to
+ensure correct platform compatibility.
+
+If you need to manually regenerate for local development:
+
+```bash
+# Regenerate requirements-docker.txt with all dependencies and hashes
+python3 scripts/generate_requirements.py \
+  --platform linux_x86_64 \
+  --python-version 311 \
+  --output requirements-docker.txt \
+  --comment "PDM and all its dependencies for Linux x86_64 platform" \
+  pdm==2.24.2
+
+# Or specify a different PDM version
+python3 scripts/generate_requirements.py \
+  --platform linux_x86_64 \
+  --python-version 311 \
+  --output requirements-docker.txt \
+  --comment "PDM and all its dependencies for Linux x86_64 platform" \
+  pdm==2.26.0
+
+# Test the Docker build
+docker build . --platform linux/arm64 -t http-api-tool-test
+```
+
+The `requirements-docker.txt` file contains:
+
+- PDM and all its transitive dependencies
+- SHA256 hashes for Linux ARM64 platform
+- Security protection against supply chain attacks
+- Ensures reproducible Docker builds
+
+**When to regenerate:**
+
+- Updating PDM version in the project
+- Docker build failures with hash verification errors
+- Setting up the project for the first time
+- After changes to `pyproject.toml` affecting PDM dependencies
+
+### Local Development
+
+```bash
+# Test CLI functionality
+pdm run python -m http_api_tool test --help
+
+# Test against local server
+python -m http.server 8000 &
+pdm run python -m http_api_tool test --url http://localhost:8000
+```
+
+### Testing with go-httpbin Service
+
+For testing HTTP API functionality, you can either use the go-httpbin GitHub
+Action for workflows or set up a local go-httpbin service for development.
+
+#### Using the go-httpbin GitHub Action
+
+For GitHub Actions workflows, use the standalone go-httpbin action to set up an
+HTTPS testing service:
+
+<!-- markdownlint-disable MD013 -->
+
+```yaml
+steps:
+  - name: Setup go-httpbin HTTPS service
+    uses: lfreleng-actions/go-httpbin-action@fd9c3701056fc2e667542ac66b4a63c44faea6c5 # v0.1.0
+    id: httpbin
+    with:
+      debug: 'true'
+      port: '8080'
+
+  - name: Test API with go-httpbin
+    uses: lfreleng-actions/http-api-tool-docker@main
+    with:
+      url: 'https://localhost:8080/get'
+      ca_bundle_path: 'mkcert-ca.pem'
+      expected_http_code: '200'
+```
+
+<!-- markdownlint-enable MD013 -->
+
+#### Using Local go-httpbin Service for Development
+
+For local development and testing:
+
+```bash
+# Start local go-httpbin service
+make setup-go-httpbin
+
+# Test Docker container against local service
+make test-with-httpbin
+
+# Manual testing with local service
+docker run --rm --network host \
+  -v $(PWD)/mkcert-ca.pem:/tmp/mkcert-ca.pem:ro \
+  http-api-tool \
+  test \
+  --url https://localhost:8080/get \
+  --http-method GET \
+  --expected-http-code 200 \
+  --ca-bundle-path /tmp/mkcert-ca.pem
+
+# Stop local service when done
+make stop-go-httpbin
+```
+
+The local go-httpbin service provides all the same endpoints as httpbin.org
+but runs locally for faster, more reliable testing.
+
+The `setup-go-httpbin` target automatically:
+
+- Installs mkcert if not present
+- Creates a local Certificate Authority (CA)
+- Generates SSL certificates for localhost
+- Saves the CA certificate as `mkcert-ca.pem` in the project root
+- Starts the go-httpbin service with proper HTTPS support
+
+This ensures that SSL certificate validation remains enabled for all tests,
+providing a more realistic testing environment.
+
+## Migration from Shell Version
+
+If you're migrating from the original shell-based implementation:
+
+1. **Input Compatibility**: Most inputs remain the same with updated naming
+2. **Output Compatibility**: Outputs are similar with enhanced information
+3. **Behavior Changes**:
+   - Better JSON handling (no more escaping issues)
+   - More robust error reporting
+   - Improved retry logic with exponential backoff
+   - Better SSL/TLS handling
+   - Enhanced debugging output
+   - More comprehensive response metrics
+
+## Migration to PDM
+
+This project uses PDM (Python Dependency Manager) for dependency management:
+
+### For Development
+
+Install dependencies with:
+
+```bash
+pip install --no-cache-dir pdm==2.24.2
+pdm install --dev
+```
+
+Run unit tests with:
+
+```bash
+pdm run pytest tests/ -v
+```
+
+## Requirements
+
+- Python 3.10+
+- PDM (Python Dependency Manager)
+- pycurl
+- typer (for CLI usage)
+
+PDM manages dependencies, with hash-verified lock files for reproducible builds.
+
+## License
+
+Apache-2.0 License. See [LICENSE](LICENSE) for details.
+
+## Contributing
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests for new functionality
+5. Run pre-commit hooks
+6. Submit a pull request