Skip to main content

A simple CORS proxy utility with requests-like response

Project description

jupyterlite-simple-cors-proxy

Simple CORS proxy wrapper for making http requests from JupyterLite. Uses https://corsproxy.io/

Installation

pip install jupyterlite-simple-cors-proxy

Usage

from jupyterlite_simple_cors_proxy.proxy import cors_proxy_get, robust_get_request, furl, xurl

# Set up
url = "https://api.example.com/data"
# Optional params
params = {"key": "value"}

# Get a cross-origin proxied url
cross_origin_url = xurl(url) # xurl(url, params)

# Get a file like object
# (Make the request, then create a file like object
# from the response)
file_ob = furl(url) # furl(url, params)

# Make a request
response = cors_proxy_get(url, params)

# Use like requests
print(response.text)
data = response.json()
raw = response.content

The robust_get_request() will first try a simple request, then a proxied request: robust_get_request(url, params)

Features

  • Simple CORS proxy wrapper
  • Requests response object
  • Support for URL parameters

fastf1 cors proxy

A monkey patch for fastf1 is provided as:

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/",
)

CorsProxy with cache facility

Via claude.ai, the package is now further enriched.

Note that pyodide sqlite can't write to /drive so the cache path dir needs to be something like /tmp or a dir created on /.

I'm not convinced the following works in pyodide and xeus-python yet - requests-cache dependency issues etc. requests-cache has requirements attrs, cattrs,platformdirs, url-normalize.

from simple_cors_proxy.proxy import CorsProxy

# Create a cached proxy instance
proxy = CorsProxy(use_cache=True, expire_after=3600)  # Cache for 1 hour

# Use furl directly from your proxy instance
file_like = proxy.furl('https://example.com/somefile.csv')

#----
import pandas as pd
from simple_cors_proxy.cacheproxy import CorsProxy

proxy = CorsProxy(use_cache=True)
file_like = proxy.furl('https://example.com/data.csv')
df = pd.read_csv(file_like)

#----

from simple_cors_proxy.proxy import create_cached_proxy

proxy = create_cached_proxy(cache_name='my_cache', expire_after=86400)  # Cache for 1 day
file_like = proxy.furl('https://example.com/somefile.csv')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlite_simple_cors_proxy-0.1.15.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file jupyterlite_simple_cors_proxy-0.1.15.tar.gz.

File metadata

File hashes

Hashes for jupyterlite_simple_cors_proxy-0.1.15.tar.gz
Algorithm Hash digest
SHA256 8af7d46dd214e0b8de525ef9d239e7110c99473179c2b4f1a98a80d774d93560
MD5 95ff348e2c64db2a952816960d010365
BLAKE2b-256 2e0bc1061fa6509081b4c55b5a4b10375dc5cba0a846842bda7e351943c9403a

See more details on using hashes here.

File details

Details for the file jupyterlite_simple_cors_proxy-0.1.15-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlite_simple_cors_proxy-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 3d01432c7a3cec091cbdacf7c8fcd4d97de1d44e07ce2e8b3b42a6c5eb3ca62a
MD5 eac6eaed8c72b4b8dee7539ebf98b651
BLAKE2b-256 6dc624859299de2bca47d721a52ab32bac89b8819af15d67fc70b4f9e5400625

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page