Skip to main content

An ASGI function for proxying to a backend over HTTP

Project description

asgi-proxy-lib

PyPI Changelog License

An ASGI function for proxying to a backend over HTTP

⚠️ Warning: this is an early alpha.

Installation

Install this library using pip:

pip install asgi-proxy-lib

Usage

This library provides a single ASGI function called asgi_proxy. You can use it like this:

from asgi_proxy import asgi_proxy

app = asgi_proxy("https://datasette.io")

Now app is an ASGI application that will proxy all incoming HTTP requests to the equivalent URL on https://datasette.io.

The function takes an optional second argument, log= - set this to a Python logger, or any object that has .info(msg) and .error(msg) methods, and the proxy will log information about each request it proxies.

CLI tool

You can try this module out like so:

python -m asgi_proxy https://datasette.io

This will start a server on port 8000 that proxies to https://datasette.io.

Add -p PORT to specify a different port, --verbose to see debug logging, and --host 127.0.0.1 to listen on a different host (the default is 0.0.0.0).

Development

To contribute to this library, first checkout the code. Then create a new virtual environment:

cd asgi-proxy-lib
python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest

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

asgi-proxy-lib-0.1a0.tar.gz (7.8 kB view hashes)

Uploaded Source

Built Distribution

asgi_proxy_lib-0.1a0-py3-none-any.whl (7.9 kB view hashes)

Uploaded Python 3

Supported by

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