jupyterlite-simple-cors-proxy 0.1.8__py3-none-any.whl → 0.1.9__py3-none-any.whl

jupyterlite_simple_cors_proxy/__init__.py

@@ -3,5 +3,5 @@ from .proxy import cors_proxy_get, robust_get_request, xurl, furl
 
 # from .fastf1_proxy import enable_cors_proxy as fastf1_cors_proxy
 
-__version__ = "0.1.8"
+__version__ = "0.1.9"
 __all__ = ["cors_proxy_get", "robust_get_request", "xurl", "furl"]

jupyterlite_simple_cors_proxy/proxy.py

@@ -1,52 +1,83 @@
 # File: simple_cors_proxy/proxy.py
 from urllib.parse import urlencode, quote
 import requests
+import requests_cache
 import io
-
 import platform
-PLATFORM = platform.system().lower()
-
-def xurl(url, params=None, force=False):
-    """Generate a proxied URL."""
-    if PLATFORM=="emscripten" or force:
-        if params:
-            url = f"{url}?{urlencode(params)}"
-        url = f"https://corsproxy.io/{quote(url)}"
+from typing import Optional, Union
 
-    return url
-
-def furl(url, params=None, force=False):
-    """Return file like object after calling the proxied URL."""
-    r = cors_proxy_get(url, params, force)
+PLATFORM = platform.system().lower()
 
-    # Return a file-like object from the JSON string
-    return io.BytesIO(r.content)
+class CorsProxy:
+    """CORS Proxy with optional caching support."""
+    
+    def __init__(self, use_cache: bool = False, **cache_kwargs):
+        """
+        Initialize the CORS proxy.
+        
+        Args:
+            use_cache: Whether to enable request caching
+            **cache_kwargs: Arguments passed to requests_cache.CachedSession
+                          (e.g., cache_name, backend, expire_after)
+        """
+        if use_cache:
+            # Set some sensible defaults if not provided
+            if 'cache_name' not in cache_kwargs:
+                cache_kwargs['cache_name'] = 'cors_proxy_cache'
+            if 'expire_after' not in cache_kwargs:
+                cache_kwargs['expire_after'] = 3600  # 1 hour default
+            self.session = requests_cache.CachedSession(**cache_kwargs)
+        else:
+            self.session = requests
 
+    def xurl(self, url: str, params: Optional[dict] = None, force: bool = False) -> str:
+        """Generate a proxied URL."""
+        if PLATFORM == "emscripten" or force:
+            if params:
+                url = f"{url}?{urlencode(params)}"
+            url = f"https://corsproxy.io/{quote(url)}"
+        return url
 
-def cors_proxy_get(url, params=None, force=False):
-    """
-    CORS proxy for GET resources with requests-like response.
+    def furl(self, url: str, params: Optional[dict] = None, force: bool = False) -> io.BytesIO:
+        """Return file like object after calling the proxied URL."""
+        r = self.cors_proxy_get(url, params, force)
+        return io.BytesIO(r.content)
 
-    Args:
-        url (str): The URL to fetch
-        params (dict, optional): Query parameters to include
+    def cors_proxy_get(self, url: str, params: Optional[dict] = None, force: bool = False) -> requests.Response:
+        """
+        CORS proxy for GET resources with requests-like response.
+        
+        Args:
+            url: The URL to fetch
+            params: Query parameters to include
+            force: Force using the proxy even on non-emscripten platforms
+            
+        Returns:
+            A requests response object.
+        """
+        proxy_url = self.xurl(url, params, force)
+        return self.session.get(proxy_url)
 
-    Returns:
-        A requests response object.
-    """
-    proxy_url = xurl(url, params, force)
+    def robust_get_request(self, url: str, params: Optional[dict] = None) -> requests.Response:
+        """
+        Try to make a simple request else fall back to a proxy.
+        """
+        try:
+            r = self.session.get(url, params=params)
+        except:
+            r = self.cors_proxy_get(url, params=params)
+        return r
 
-    # Do a simple requests get and
-    # just pass through the entire response object
-    return requests.get(proxy_url)
+# Create default instance
+_default_proxy = CorsProxy()
 
+# Legacy function-based interface
+xurl = _default_proxy.xurl
+furl = _default_proxy.furl
+cors_proxy_get = _default_proxy.cors_proxy_get
+robust_get_request = _default_proxy.robust_get_request
 
-def robust_get_request(url, params=None):
-    """
-    Try to make a simple request else fall back to a proxy.
-    """
-    try:
-        r = requests.get(url, params=params)
-    except:
-        r = cors_proxy_get(url, params=params)
-    return r
+# Convenience function to create a cached proxy
+def create_cached_proxy(**cache_kwargs):
+    """Create a new CorsProxy instance with caching enabled."""
+    return CorsProxy(use_cache=True, **cache_kwargs)

{jupyterlite_simple_cors_proxy-0.1.8.dist-info → jupyterlite_simple_cors_proxy-0.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: jupyterlite-simple-cors-proxy
-Version: 0.1.8
+Version: 0.1.9
 Summary: A simple CORS proxy utility with requests-like response
 Home-page: https://github.com/innovationOUtside/jupyterlite-simple-cors-proxy
 Author: Tony Hirst
@@ -65,3 +65,18 @@ The `robust_get_request()` will first try a simple request, then a proxied reque
 - Simple CORS proxy wrapper
 - Requests response object
 - Support for URL parameters
+
+## `fastf1` cors proxy
+
+A monkey patch for `fastf1` is provided as:
+
+```python
+import fast f1
+from jupyterlite_simple_cors_proxy.fastf1_proxy import enable_cors_proxy
+
+enable_cors_proxy(
+#    domains=["api.formula1.com", "livetiming.formula1.com"],
+#    debug=True,
+#    proxy_url="https://corsproxy.io/",
+)
+```

jupyterlite_simple_cors_proxy-0.1.9.dist-info/RECORD

@@ -0,0 +1,8 @@
+jupyterlite_simple_cors_proxy/__init__.py,sha256=yMbwL10DDWnXt2GVs_yOQLmlQtU2dtcHfTit62Nc04g,274
+jupyterlite_simple_cors_proxy/fastf1_proxy.py,sha256=FglRogTIlSJvHOu6lFS3S-EHDb37M93aYjQpoKc1QYs,7614
+jupyterlite_simple_cors_proxy/proxy.py,sha256=SzKQrflMbIJdHoDZ2dtRenGCAGMZEBSl_fs7sjIkiHk,2989
+jupyterlite_simple_cors_proxy-0.1.9.dist-info/LICENSE,sha256=Ogw7GUmeZIxmDNiKWsu_N07svNoGnPB7lWyiXHX_rMY,1074
+jupyterlite_simple_cors_proxy-0.1.9.dist-info/METADATA,sha256=HrfzXYCuKpPWh7zCDpbmbTZGRgCtGjpvH1Q0snUAQfU,2031
+jupyterlite_simple_cors_proxy-0.1.9.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+jupyterlite_simple_cors_proxy-0.1.9.dist-info/top_level.txt,sha256=Oh0oQrSmRnBq5u675coiKMbkb2ASg8AGF8ZiZTzUS5Q,30
+jupyterlite_simple_cors_proxy-0.1.9.dist-info/RECORD,,

jupyterlite_simple_cors_proxy-0.1.8.dist-info/RECORD

@@ -1,8 +0,0 @@
-jupyterlite_simple_cors_proxy/__init__.py,sha256=fFGdcTl9-jFFAQJVrb1KXt8dh8NH-JcS79FvAtFT3T4,274
-jupyterlite_simple_cors_proxy/fastf1_proxy.py,sha256=FglRogTIlSJvHOu6lFS3S-EHDb37M93aYjQpoKc1QYs,7614
-jupyterlite_simple_cors_proxy/proxy.py,sha256=hF7SeLx7whBkE8m8bDUaelx2tKfLrSHA_Lp_auFtqeY,1341
-jupyterlite_simple_cors_proxy-0.1.8.dist-info/LICENSE,sha256=Ogw7GUmeZIxmDNiKWsu_N07svNoGnPB7lWyiXHX_rMY,1074
-jupyterlite_simple_cors_proxy-0.1.8.dist-info/METADATA,sha256=VCrtXTTVM4n0BsH-f2siz3s9SeWTDwGcVNJjvvfdz7k,1718
-jupyterlite_simple_cors_proxy-0.1.8.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-jupyterlite_simple_cors_proxy-0.1.8.dist-info/top_level.txt,sha256=Oh0oQrSmRnBq5u675coiKMbkb2ASg8AGF8ZiZTzUS5Q,30
-jupyterlite_simple_cors_proxy-0.1.8.dist-info/RECORD,,