httpr 0.3.1__tar.gz → 0.3.2__tar.gz

{httpr-0.3.1 → httpr-0.3.2}/.github/workflows/CI.yml

@@ -434,19 +434,27 @@ jobs:
             HTTPR_VERSION="dev"
           fi
           uv run python benchmark/benchmark.py --httpr-version "$HTTPR_VERSION"
-      - name: Generate and commit benchmark image
+      - name: Generate and deploy benchmark image to gh-pages
         if: startsWith(github.ref, 'refs/tags/')
         run: |
           uv run python benchmark/generate_image.py
           git config --global user.name 'github-actions[bot]'
           git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com'
-          # Checkout main branch to avoid detached HEAD issues
-          git fetch origin main
-          git checkout main
-          git add *.jpg
+
+          # Save the generated image
+          cp benchmark.jpg /tmp/benchmark.jpg
+
+          # Fetch and checkout gh-pages
+          git fetch origin gh-pages:gh-pages
+          git checkout gh-pages
+
+          # Copy the benchmark image
+          cp /tmp/benchmark.jpg benchmark.jpg
+
+          git add benchmark.jpg
           if ! git diff --quiet --cached; then
             git commit -m "Update benchmark image for ${{ github.ref_name }}"
-            git push origin main
+            git push origin gh-pages
           else
             echo "No changes to commit"
           fi

httpr-0.3.2/.github/workflows/mkdocs.yml

@@ -0,0 +1,88 @@
+name: mkdocs
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: "3.12"
+          enable-cache: false
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: uv sync --extra docs
+      - name: Build docs
+        run: uv run mkdocs build
+      - name: Deploy to gh-pages (preserving benchmark data)
+        run: |
+          # Capture source commit BEFORE switching branches
+          SOURCE_COMMIT=$(git rev-parse --short HEAD)
+
+          # Fetch gh-pages branch
+          git fetch origin gh-pages:gh-pages || true
+
+          # Save benchmark data if it exists
+          mkdir -p /tmp/bench-backup
+          if git show gh-pages:dev/bench/data.js > /tmp/bench-backup/data.js 2>/dev/null; then
+            echo "Found existing benchmark data.js, will preserve it"
+          fi
+          if git show gh-pages:dev/bench/index.html > /tmp/bench-backup/index.html 2>/dev/null; then
+            echo "Found existing benchmark index.html, will preserve it"
+          fi
+          # Save benchmark image if it exists
+          if git show gh-pages:benchmark.jpg > /tmp/bench-backup/benchmark.jpg 2>/dev/null; then
+            echo "Found existing benchmark.jpg, will preserve it"
+          fi
+
+          # Switch to gh-pages branch
+          git checkout gh-pages || git checkout --orphan gh-pages
+
+          # Remove all tracked files
+          git rm -rf . || true
+
+          # Copy new docs from site/ directory
+          if [ ! -d "site" ] || [ -z "$(ls -A site 2>/dev/null)" ]; then
+            echo "Error: site/ directory is empty or missing"
+            exit 1
+          fi
+          cp -r site/* .
+
+          # Restore benchmark data if it existed
+          if [ -f /tmp/bench-backup/data.js ] || [ -f /tmp/bench-backup/index.html ]; then
+            mkdir -p dev/bench
+            [ -f /tmp/bench-backup/data.js ] && cp /tmp/bench-backup/data.js dev/bench/
+            [ -f /tmp/bench-backup/index.html ] && cp /tmp/bench-backup/index.html dev/bench/
+            echo "Restored benchmark chart files"
+          fi
+          # Restore benchmark image if it existed
+          if [ -f /tmp/bench-backup/benchmark.jpg ]; then
+            cp /tmp/bench-backup/benchmark.jpg benchmark.jpg
+            echo "Restored benchmark.jpg"
+          fi
+
+          # Add all files and commit
+          git add -A
+          if git diff --cached --quiet; then
+            echo "No changes to deploy"
+          else
+            git commit -m "Deployed ${SOURCE_COMMIT} with MkDocs"
+            git push origin gh-pages --force
+          fi

{httpr-0.3.1 → httpr-0.3.2}/CLAUDE.md

@@ -145,7 +145,8 @@ uv run python benchmark.py  # Terminal 2: Run benchmarks
 ### SSL/TLS
 - CA certs loaded via `HTTPR_CA_BUNDLE` env var
 - `ca_cert_file` param sets `HTTPR_CA_BUNDLE` internally
-- mTLS via `client_pem` parameter (PEM format)
+- mTLS via `client_pem` parameter (file path, PEM format) or `client_pem_data` (bytes, PEM format)
+- `client_pem_data` allows passing certificates without filesystem access (useful for containers/secrets managers)
 - `verify=False` enables `danger_accept_invalid_certs()`
 
 ### Headers Behavior

{httpr-0.3.1 → httpr-0.3.2}/Cargo.lock

@@ -481,7 +481,7 @@ checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87"
 
 [[package]]
 name = "httpr"
-version = "0.3.1"
+version = "0.3.2"
 dependencies = [
  "anyhow",
  "bytes",

{httpr-0.3.1 → httpr-0.3.2}/Cargo.toml

@@ -2,7 +2,7 @@
 name = "httpr"
 # Version is set dynamically by CI from git tags (e.g., v1.2.3 -> 1.2.3).
 # Do not edit manually. See .github/actions/set-version/ for details.
-version = "0.3.1"
+version = "0.3.2"
 edition = "2021"
 description = "Fast HTTP client for python"
 authors = ["thomasht86"]

{httpr-0.3.1 → httpr-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: httpr
-Version: 0.3.1
+Version: 0.3.2
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
@@ -123,7 +123,7 @@ pip install -U httpr
 
 ## Benchmark
 
-![](https://github.com/thomasht86/httpr/blob/main/benchmark.jpg?raw=true)
+![](https://thomasht86.github.io/httpr/benchmark.jpg)
 
 ## Usage
 

{httpr-0.3.1 → httpr-0.3.2}/README.md

@@ -63,7 +63,7 @@ pip install -U httpr
 
 ## Benchmark
 
-![](https://github.com/thomasht86/httpr/blob/main/benchmark.jpg?raw=true)
+![](https://thomasht86.github.io/httpr/benchmark.jpg)
 
 ## Usage
 

{httpr-0.3.1 → httpr-0.3.2}/docs/advanced/ssl-tls.md

@@ -117,6 +117,33 @@ MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwgg...
 -----END PRIVATE KEY-----
 ```
 
+### Using In-Memory Certificates
+
+For containerized environments or when certificates are stored in secrets managers, you can pass the certificate data directly without writing to the filesystem:
+
+```python
+import httpr
+import os
+
+# Load certificate from environment variable or secrets manager
+cert_data = os.environ.get("CLIENT_CERT_PEM").encode()  # or from secrets manager
+
+client = httpr.Client(
+    client_pem_data=cert_data,  # Pass bytes directly
+    ca_cert_file="/path/to/ca-bundle.pem"
+)
+
+response = client.get("https://mtls.example.com/api")
+```
+
+**Benefits:**
+- No temporary files needed
+- Better security in containerized environments
+- Works with secrets managers (AWS Secrets Manager, HashiCorp Vault, etc.)
+- Reduces filesystem I/O
+
+**Note:** Either `client_pem` (file path) or `client_pem_data` (bytes) can be used, but not both.
+
 ### Complete mTLS Example
 
 ```python

{httpr-0.3.1 → httpr-0.3.2}/httpr/__init__.py

@@ -117,6 +117,7 @@ class Client(RClient):
         verify: bool | None = True,
         ca_cert_file: str | None = None,
         client_pem: str | None = None,
+        client_pem_data: bytes | None = None,
         https_only: bool | None = False,
         http2_only: bool | None = False,
     ):
@@ -140,6 +141,8 @@ class Client(RClient):
             verify: Verify SSL certificates. Default is True.
             ca_cert_file: Path to CA certificate bundle (PEM format).
             client_pem: Path to client certificate for mTLS (PEM format).
+            client_pem_data: Client certificate and key as bytes for mTLS (PEM format).
+                Use this instead of client_pem when you have the certificate in memory.
             https_only: Only allow HTTPS requests. Default is False.
             http2_only: Use HTTP/2 only (False uses HTTP/1.1). Default is False.
 
@@ -165,11 +168,18 @@ class Client(RClient):
             # Client with proxy
             client = httpr.Client(proxy="http://proxy.example.com:8080")
 
-            # Client with mTLS
+            # Client with mTLS using file path
             client = httpr.Client(
                 client_pem="/path/to/client.pem",
                 ca_cert_file="/path/to/ca.pem",
             )
+
+            # Client with mTLS using direct certificate data
+            cert_data = b"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----"
+            client = httpr.Client(
+                client_pem_data=cert_data,
+                ca_cert_file="/path/to/ca.pem",
+            )
             ```
         """
         super().__init__()
@@ -787,6 +797,7 @@ def request(
     verify: bool | None = True,
     ca_cert_file: str | None = None,
     client_pem: str | None = None,
+    client_pem_data: bytes | None = None,
     **kwargs: Unpack[RequestParams],
 ) -> Response:
     """
@@ -801,6 +812,7 @@ def request(
         verify: Verify SSL certificates. Default is True.
         ca_cert_file: Path to CA certificate bundle.
         client_pem: Path to client certificate for mTLS.
+        client_pem_data: Client certificate and key as bytes for mTLS.
         **kwargs: Additional request parameters.
 
     Returns:
@@ -818,6 +830,7 @@ def request(
         verify=verify,
         ca_cert_file=ca_cert_file,
         client_pem=client_pem,
+        client_pem_data=client_pem_data,
     ) as client:
         return client.request(method, url, **kwargs)
 

{httpr-0.3.1 → httpr-0.3.2}/httpr/httpr.pyi

@@ -28,6 +28,7 @@ class ClientRequestParams(RequestParams):
     verify: bool | None
     ca_cert_file: str | None
     client_pem: str | None
+    client_pem_data: bytes | None
 
 class CaseInsensitiveHeaderMap:
     """
@@ -286,6 +287,7 @@ class RClient:
         verify: bool | None = True,
         ca_cert_file: str | None = None,
         client_pem: str | None = None,
+        client_pem_data: bytes | None = None,
         https_only: bool | None = False,
         http2_only: bool | None = False,
     ): ...
@@ -374,6 +376,7 @@ class Client(RClient):
         verify: bool | None = True,
         ca_cert_file: str | None = None,
         client_pem: str | None = None,
+        client_pem_data: bytes | None = None,
         https_only: bool | None = False,
         http2_only: bool | None = False,
     ) -> None:
@@ -395,6 +398,7 @@ class Client(RClient):
             verify: Verify SSL certificates. Default is True.
             ca_cert_file: Path to CA certificate bundle (PEM format).
             client_pem: Path to client certificate for mTLS (PEM format).
+            client_pem_data: Client certificate and key as bytes for mTLS (PEM format).
             https_only: Only allow HTTPS requests. Default is False.
             http2_only: Use HTTP/2 only. Default is False.
         """
@@ -472,6 +476,7 @@ class AsyncClient(Client):
         verify: bool | None = True,
         ca_cert_file: str | None = None,
         client_pem: str | None = None,
+        client_pem_data: bytes | None = None,
         https_only: bool | None = False,
         http2_only: bool | None = False,
     ) -> None:

{httpr-0.3.1 → httpr-0.3.2}/pyproject.toml

@@ -11,7 +11,7 @@ keywords = [ "python", "request",]
 classifiers = [ "Programming Language :: Rust", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Internet :: WWW/HTTP", "Topic :: Software Development :: Libraries :: Python Modules",]
 # Version is set dynamically by CI from git tags (e.g., v1.2.3 -> 1.2.3).
 # Do not edit manually. See .github/actions/set-version/ for details.
-version = "0.3.1"
+version = "0.3.2"
 dependencies = []
 [[project.authors]]
 name = "thomasht86"

{httpr-0.3.1 → httpr-0.3.2}/src/lib.rs

@@ -7,6 +7,7 @@ use anyhow::anyhow;
 use bytes::Bytes;
 use foldhash::fast::RandomState;
 use indexmap::IndexMap;
+use pyo3::exceptions::PyValueError;
 use pyo3::prelude::*;
 use pyo3::types::PyBytes;
 use pythonize::depythonize;
@@ -115,7 +116,7 @@ impl RClient {
     #[new]
     #[pyo3(signature = (auth=None, auth_bearer=None, params=None, headers=None, cookies=None,
         cookie_store=true, referer=true, proxy=None, timeout=None, follow_redirects=true,
-        max_redirects=20, verify=true, ca_cert_file=None, client_pem=None, https_only=false, http2_only=false))]
+        max_redirects=20, verify=true, ca_cert_file=None, client_pem=None, client_pem_data=None, https_only=false, http2_only=false))]
     fn new(
         auth: Option<(String, Option<String>)>,
         auth_bearer: Option<String>,
@@ -131,9 +132,15 @@ impl RClient {
         verify: Option<bool>,
         ca_cert_file: Option<String>,
         client_pem: Option<String>,
+        client_pem_data: Option<Vec<u8>>,
         https_only: Option<bool>,
         http2_only: Option<bool>,
     ) -> PyResult<Self> {
+        if client_pem.is_some() && client_pem_data.is_some() {
+            return Err(PyValueError::new_err(
+                "Only one of client_pem or client_pem_data may be set.",
+            ));
+        }
         // Client builder
         let mut client_builder = reqwest::Client::builder();
 
@@ -195,11 +202,17 @@ impl RClient {
                 }
             }
             // Load client pem identity if provided
-            if let Some(client_pem) = &client_pem {
-                let client_identity_pem =
-                    fs::read(client_pem).map_err(|e| map_anyhow_error(anyhow::Error::new(e)))?;
-                let identity =
-                    Identity::from_pem(&client_identity_pem).map_err(map_reqwest_error)?;
+            // Either from file path (client_pem) or direct data (client_pem_data)
+            let client_identity_pem = if let Some(pem_data) = &client_pem_data {
+                Some(pem_data.clone())
+            } else if let Some(pem_path) = &client_pem {
+                Some(fs::read(pem_path).map_err(|e| map_anyhow_error(anyhow::Error::new(e)))?)
+            } else {
+                None
+            };
+
+            if let Some(pem_bytes) = client_identity_pem {
+                let identity = Identity::from_pem(&pem_bytes).map_err(map_reqwest_error)?;
                 client_builder = client_builder.identity(identity);
             }
         } else {

{httpr-0.3.1 → httpr-0.3.2}/tests/unit/test_ssl.py

@@ -1,3 +1,5 @@
+import asyncio
+import contextlib
 import http.server
 import os
 import ssl
@@ -7,8 +9,8 @@ import unittest
 
 import trustme
 
-# Import your Client class
-from httpr import Client
+import httpr
+from httpr import AsyncClient, Client
 
 
 class SSLTestHandler(http.server.BaseHTTPRequestHandler):
@@ -21,8 +23,6 @@ class SSLTestHandler(http.server.BaseHTTPRequestHandler):
         self.wfile.write(b"OK")
 
     def finish(self):
-        import contextlib
-
         try:
             self.wfile.flush()
             self.request.settimeout(1.0)
@@ -94,6 +94,30 @@ class TestClientSSL(unittest.TestCase):
             self.assertEqual(response.status_code, 200)
             self.assertEqual(response.text, "OK")
 
+    def test_valid_ssl_connection_with_pem_data(self):
+        """A connection with client_pem_data (bytes) should work the same as client_pem (path)."""
+        # Read the certificate file into memory
+        with open(self.client_cert_path, "rb") as f:
+            cert_data = f.read()
+
+        # Use client_pem_data instead of client_pem
+        with Client(client_pem_data=cert_data, ca_cert_file=self.client_ca_path) as client:
+            response = client.get(f"https://localhost:{self.server_port}")
+            self.assertEqual(response.status_code, 200)
+            self.assertEqual(response.text, "OK")
+
+    def test_client_pem_and_data_are_mutually_exclusive(self):
+        """Passing both client_pem and client_pem_data should raise a ValueError."""
+        with open(self.client_cert_path, "rb") as f:
+            cert_data = f.read()
+
+        with self.assertRaises(ValueError):
+            Client(
+                client_pem=self.client_cert_path,
+                client_pem_data=cert_data,
+                ca_cert_file=self.client_ca_path,
+            )
+
     def test_missing_client_cert(self):
         """Omitting the client certificate should fail the handshake (server requires it)."""
         with Client(ca_cert_file=self.client_ca_path) as client:
@@ -102,9 +126,6 @@ class TestClientSSL(unittest.TestCase):
 
     def test_invalid_client_cert_path(self):
         """Providing a non-existent client certificate file should raise an error."""
-        # Import httpr to use the correct exception type
-        import httpr
-
         with self.assertRaises(httpr.RequestError):
             # Assuming your Client loads the file on initialization.
             with Client(client_pem="nonexistent.pem", ca_cert_file=self.client_ca_path) as client:
@@ -126,6 +147,55 @@ class TestClientSSL(unittest.TestCase):
             with self.assertRaises(Exception):
                 client.get(f"https://localhost:{self.server_port}")
 
+    def test_async_client_with_pem_data(self):
+        """AsyncClient with client_pem_data should work the same as sync Client."""
+        with open(self.client_cert_path, "rb") as f:
+            cert_data = f.read()
+
+        async def make_request():
+            async with AsyncClient(
+                client_pem_data=cert_data, ca_cert_file=self.client_ca_path
+            ) as client:
+                return await client.get(f"https://localhost:{self.server_port}")
+
+        response = asyncio.run(make_request())
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.text, "OK")
+
+    def test_request_function_with_pem_data(self):
+        """The request() convenience function should accept client_pem_data."""
+        with open(self.client_cert_path, "rb") as f:
+            cert_data = f.read()
+
+        response = httpr.request(
+            "GET",
+            f"https://localhost:{self.server_port}",
+            client_pem_data=cert_data,
+            ca_cert_file=self.client_ca_path,
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.text, "OK")
+
+    def test_invalid_pem_data_raises_error(self):
+        """Malformed PEM data should raise an appropriate error."""
+        with self.assertRaises(httpr.RequestError):
+            Client(
+                client_pem_data=b"not valid pem data",
+                ca_cert_file=self.client_ca_path,
+            )
+
+    def test_async_client_pem_and_data_are_mutually_exclusive(self):
+        """AsyncClient should also enforce mutual exclusivity."""
+        with open(self.client_cert_path, "rb") as f:
+            cert_data = f.read()
+
+        with self.assertRaises(ValueError):
+            AsyncClient(
+                client_pem=self.client_cert_path,
+                client_pem_data=cert_data,
+                ca_cert_file=self.client_ca_path,
+            )
+
 
 if __name__ == "__main__":
     unittest.main()

httpr-0.3.1/.github/workflows/mkdocs.yml

@@ -1,30 +0,0 @@
-name: mkdocs
-on:
-  push:
-    branches:
-      - master
-      - main
-permissions:
-  contents: write
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: astral-sh/setup-uv@v7
-        with:
-          python-version: "3.12"
-          enable-cache: false
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - run: uv sync --extra docs
-      - run: uv run mkdocs gh-deploy --force