Skip to main content

A Python wrapper for the Cloudflare KV Store API

Project description

CFKV

Deploy > PYPI > Test

Release

A simple wrapper to communicate with Cloudflare KV Store . It can be used as a cache and features will be implemented to be used in frameworks such as FastAPI

  • Set and Get
  • Fastapi Middleware
  • Flask integration
  • Options to include string instead of dict entry

Simple Usage

import datetime
from cfkv import KVStore

store = KVStore(namespace_id="YOUR_NAMESPACE_ID", account_id="ACCOUNT_ID", api_key="API_KEY")

# Usage Example
key = "sample_key"
get = store.get(key)

if get is None:
    data = {"test": True, "date": str(datetime.datetime.now())}
    store.set(key)
    data['stored'] = False
    get = data
else:
    data['stored'] = True

print(get)

Setup

You will need to know your namespace id which is generated when you create a KV namespace and Account ID. To generate the KV api key follow the instructions below

  1. Navigate to Cloudflare API Tokens
  2. Create API Token
  3. Scroll down to create custom token
  4. Create a token with Workers KV Storage and select Edit

Example Token

You can use environment variables to store these the following are monitored

KV_NAMESPACE_ID="YOUR_NAMESPACE_ID"
CF_ACCOUNT_ID="YOUR_ACCOUNT_ID"
CF_API_KEY="YOUR_API_KEY"

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

cfkv-1.1.2.tar.gz (3.9 kB view hashes)

Uploaded Source

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