Skip to main content

Tiny state sync over GitHub Gists (ETag-aware).

Project description

GistFlow

A tiny Python library + CLI for syncing small JSON state via a GitHub Gist.

gistflow is useful when you want a cheap, globally reachable state blob over HTTPS without running your own server. Reads are efficient using HTTP ETags (If-None-Match), so polling is lightweight.

This project intentionally keeps scope small and explicit.


Design goals

  • Small and boring
  • Explicit configuration
  • ETag-aware polling
  • No hidden magic

Non-goals

  • Automatic worker discovery
  • Strong consistency or atomic multi-writer updates
  • High-frequency messaging
  • Large payloads

Requirements

  • Python 3.9+
  • A GitHub account
  • A GitHub Personal Access Token with Gists: read/write

Installation (development)

pip install -e .

License

MIT

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

gistflow-0.1.1.tar.gz (9.6 kB view details)

Uploaded Source

Built Distribution

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

gistflow-0.1.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file gistflow-0.1.1.tar.gz.

File metadata

  • Download URL: gistflow-0.1.1.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for gistflow-0.1.1.tar.gz
Algorithm Hash digest
SHA256 0b4ec5c008fc3b2f040a4f6f25548569087fd6a5f44850f0832d1d95d0a6c4d2
MD5 6b1bdb0f19617bb5e16425a66d765043
BLAKE2b-256 4dc46a3fa3ce72c28b66f12d6d10db04ca16aa05e95a611997f8d0d46041878d

See more details on using hashes here.

File details

Details for the file gistflow-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: gistflow-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for gistflow-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ad60174753787acf58bb8d960b8e303bd9c6204a6b6ae3e80877a7523bfedf03
MD5 3b17a731b099c0f4debae0c54f9a8744
BLAKE2b-256 04e9103a14fed3ab47e1f7d15797ee59e9d1676f79e3bb2e3b487106190c8354

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