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

jupyterlite_simple_cors_proxy/__init__.py

@@ -1,6 +1,7 @@
 # File: jupyterlite_simple_cors_proxy/__init__.py
 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.7"
-__all__ = ["cors_proxy_get", "robust_get_request", "xurl", "furl", "fastf1_cors_proxy"]
+# from .fastf1_proxy import enable_cors_proxy as fastf1_cors_proxy
+
+__version__ = "0.1.9"
+__all__ = ["cors_proxy_get", "robust_get_request", "xurl", "furl"]

jupyterlite_simple_cors_proxy/fastf1_proxy.py

@@ -1,8 +1,8 @@
-#import functools
+# import functools
 from urllib.parse import urlparse, quote
 import requests
-#import requests_cache
-#from requests_cache.session import CachedSession
+# import requests_cache
+# from requests_cache.session import CachedSession
 import fastf1
 import logging
 from typing import List, Optional, Dict, Any
@@ -19,7 +19,7 @@ class ProxyConfig:
 
 class CORSProxyPatcher:
     """Patches FastF1 to handle CORS requests through a proxy service."""
-    
+
     def __init__(self, config: ProxyConfig = None):
         """
         Initialize the CORS proxy patcher for FastF1.
@@ -28,11 +28,14 @@ class CORSProxyPatcher:
             config (ProxyConfig): Configuration object for the proxy
         """
         self.config = config or ProxyConfig()
-        self.domains = self.config.domains or []
-        
+        self.domains = self.config.domains or [
+            "api.formula1.com",
+            "livetiming.formula1.com",
+        ]
+
         self._setup_logging()
         self._setup_session()
-        
+
     def _setup_logging(self) -> None:
         """Configure logging based on debug setting."""
         self.logger = logging.getLogger('CORSProxyPatcher')
@@ -41,7 +44,7 @@ class CORSProxyPatcher:
                 level=logging.DEBUG,
                 format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
             )
-    
+
     def _setup_session(self) -> None:
         """Set up the requests session with retry functionality."""
         self.session = requests.Session()
@@ -53,7 +56,7 @@ class CORSProxyPatcher:
         adapter = requests.adapters.HTTPAdapter(max_retries=retry_strategy)
         self.session.mount("http://", adapter)
         self.session.mount("https://", adapter)
-    
+
     def should_proxy(self, url: str) -> bool:
         """
         Check if the URL should be routed through proxy based on domain.
@@ -69,7 +72,7 @@ class CORSProxyPatcher:
         if self.config.debug:
             self.logger.debug(f"URL: {url} - Should proxy: {should_proxy}")
         return should_proxy
-    
+
     def get_proxied_url(self, url: str) -> str:
         """
         Get the proxied version of the URL if needed.
@@ -90,7 +93,7 @@ class CORSProxyPatcher:
                 self.logger.debug(f"Proxied URL: {proxied}")
             return proxied
         return url
-        
+
     def modify_headers(self, headers: Optional[Dict[str, str]] = None) -> Dict[str, str]:
         """
         Modify request headers to handle CORS.
@@ -149,19 +152,19 @@ class CORSProxyPatcher:
         modified_headers = self.modify_headers(headers)
         kwargs['headers'] = modified_headers
         kwargs['timeout'] = kwargs.get('timeout', self.config.timeout)
-        
+
         try:
             if fastf1.Cache._requests_session_cached and not fastf1.Cache._tmp_disabled:
                 session = fastf1.Cache._requests_session_cached
             else:
                 session = self.session
-                
+
             response = getattr(session, method)(proxied_url, **kwargs)
             response.raise_for_status()
-            
+
             self.log_response(response, url)
             return response
-            
+
         except requests.exceptions.RequestException as e:
             if self.config.debug:
                 self.logger.error(f"Request failed: {str(e)}")
@@ -171,10 +174,10 @@ class CORSProxyPatcher:
         """Patch FastF1's request methods to use CORS proxy."""
         def wrapped_get(cls, url: str, headers: Optional[Dict[str, str]] = None, **kwargs: Any) -> requests.Response:
             return self.make_request('get', url, headers, **kwargs)
-            
+
         def wrapped_post(cls, url: str, headers: Optional[Dict[str, str]] = None, **kwargs: Any) -> requests.Response:
             return self.make_request('post', url, headers, **kwargs)
-            
+
         fastf1.Cache.requests_get = classmethod(wrapped_get)
         fastf1.Cache.requests_post = classmethod(wrapped_post)
 
@@ -205,8 +208,14 @@ def enable_cors_proxy(
         retry_count=retry_count,
         timeout=timeout
     )
-    
+
     patcher = CORSProxyPatcher(config)
     patcher.patch_fastf1()
-    
-    return patcher
+
+    return patcher
+
+# enable_cors_proxy(
+#    domains=["api.formula1.com", "livetiming.formula1.com"],
+#    debug=True,
+#    proxy_url="https://corsproxy.io/",
+# )

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.7.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.7
+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
@@ -23,7 +23,7 @@ Dynamic: requires-python
 Dynamic: summary
 
 # jupyterlite-simple-cors-proxy
-Simple CORS proxy for making http requests from JupyterLite
+Simple CORS proxy wrapper for making http requests from JupyterLite. Uses https://corsproxy.io/
 
 ## Installation
 
@@ -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.7.dist-info/RECORD

@@ -1,8 +0,0 @@
-jupyterlite_simple_cors_proxy/__init__.py,sha256=4IEZXGJ78nCMkOujvGFjwgNf3Rmv77u_lkZWufob5wU,292
-jupyterlite_simple_cors_proxy/fastf1_proxy.py,sha256=zsLspQjuj9gw4qbsFRydZvmfLelXUmb3gUOXjrGzQgs,7505
-jupyterlite_simple_cors_proxy/proxy.py,sha256=hF7SeLx7whBkE8m8bDUaelx2tKfLrSHA_Lp_auFtqeY,1341
-jupyterlite_simple_cors_proxy-0.1.7.dist-info/LICENSE,sha256=Ogw7GUmeZIxmDNiKWsu_N07svNoGnPB7lWyiXHX_rMY,1074
-jupyterlite_simple_cors_proxy-0.1.7.dist-info/METADATA,sha256=oXlGf3Dux_i1RHxUOF5IUOUqNECoZ-4EkLUkTn1UsWc,1682
-jupyterlite_simple_cors_proxy-0.1.7.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-jupyterlite_simple_cors_proxy-0.1.7.dist-info/top_level.txt,sha256=Oh0oQrSmRnBq5u675coiKMbkb2ASg8AGF8ZiZTzUS5Q,30
-jupyterlite_simple_cors_proxy-0.1.7.dist-info/RECORD,,