Skip to main content

Versioning Caching kinda-Proxy for decoupling external responses

Project description

Buffy

Versioning and caching kinda-proxy for decoupling external HTTP resources

Maintainer: Tim Bleimehl

Status: alpha (WIP - do not use productive yet)

Source: https://git.connect.dzd-ev.de/dzdpythonmodules/buffy

User documentation: https://dzd-ev.github.io/buffy-docs.github.io/

Public issue tracker: https://github.com/dzd-ev/buffy-docs.github.io/issues



What is this?


Buffy is a server/client framework to buffer/cache your http requests.
Buffy decouples your dependency on external webservers that are not under your control.
Buffy manages HTTP downloads in the background. You can ignore any issues with external webservers and just focus on your application.

Features


  • Versioning of changing downloads
  • Pre-cache long running downloads before you need them
  • Dampen load on external servers - prevent 429 Too Many Requests errors
  • As a "smart" Downloader
    • Resume broken downloads
    • Retry corrupted downloads

At the moment there is only a python client library. But the server has a REST API that can be consumed from any coding language. You are welcome to write a client in your language.

Quick Start Client


Lets have a small example how your Buffy client code could look like.

Install Buffy

pip install DZDBuffy

Example

Lets write some code using the Buffy client

from buffy.buffypyclient import BuffyPyClient

# connect to buffy server
c = BuffyPyClient(ssl=False)

# create a request
req = c.create_request(
    url="https://ftp.ncbi.nlm.nih.gov/pubmed/baseline/pubmed22n0003.xml.gz"
)

# save requested file
req.download_response_content_to(dir="/tmp")

This is all it takes to request a file. Next time the webserver at ftp.ncbi.nlm.nih.go should be down the buffy client will just serve you the cached answer. Should your Buffy server be down, the client will fall back to direct downloading the request from the source.

See the documenation for more detailed examples on how to use the client

Quick Start Server


Requirements

Server start

  • Download the buffy docker-compose file
wget -O docker-compose.yaml https://git.connect.dzd-ev.de/dzdpythonmodules/buffy/-/raw/main/docker-compose.yaml?inline=false
  • Start the Buffy server with docker compose
docker-compose up -d

Connecting the BuffyPyClient

Create a python script.

# connect to buffy server
from buffy.buffypyclient import BuffyPyClient

# connect to buffy server
c = BuffyPyClient(host="localhost", port=8008, ssl=False)

See the documentation for more detailed examples on how to use the client

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

DZDBuffy-0.5.0.tar.gz (935.8 kB view details)

Uploaded Source

Built Distribution

DZDBuffy-0.5.0-py3-none-any.whl (42.5 kB view details)

Uploaded Python 3

File details

Details for the file DZDBuffy-0.5.0.tar.gz.

File metadata

  • Download URL: DZDBuffy-0.5.0.tar.gz
  • Upload date:
  • Size: 935.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for DZDBuffy-0.5.0.tar.gz
Algorithm Hash digest
SHA256 eb8b9ba70a1c4fa6a5317a8e5c5a89230f337e54f06f02982752cfea3d472a43
MD5 341347d6ad59383037774bc0f34724b3
BLAKE2b-256 6c767a8dd3b86ca06ac771bfd3e17b63175b4aa959403f27c739ae92bbd60817

See more details on using hashes here.

File details

Details for the file DZDBuffy-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: DZDBuffy-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 42.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.6

File hashes

Hashes for DZDBuffy-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2f3ce5d7fbaff17698da1edb80700ba1124cd414bb4b4cae7819ce2766a8bb5c
MD5 b2155f241bae0e09395c9c1138f9ae8d
BLAKE2b-256 9cf55d1663ca94a58ae20bd4b6f399d028a8dd2c9154886dc47f3b23ad83875c

See more details on using hashes here.

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