Skip to main content

Use GitHub repos as an encrypted, high-performance database

Project description

Gitnix Python SDK

Use GitHub repos as an encrypted, high-performance database.

Installation

pip install gitnix

Usage

import os
from gitnix import Gitnix
from gitnix.types import GitnixConfig

async def main():
    db = Gitnix(GitnixConfig(
        repo="owner/my-database",
        token=os.environ["GITHUB_TOKEN"],
        password="my-master-password",
    ))

    async with db:
        users = db.collection("users")
        await users.insert({"name": "Alice", "age": 30})
        alice = await users.find_one({"name": "Alice"})
        print(alice)

Features

  • Zero-knowledge encryption (GitHub never sees plaintext)
  • MongoDB-style queries ($eq, $gt, $in, $or, etc.)
  • Binary/image storage with chunking
  • Multi-repo overflow when storage limits hit
  • Transactions with optimistic locking
  • asyncio-native with full type hints

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

gitnix-1.0.0.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

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

gitnix-1.0.0-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

Details for the file gitnix-1.0.0.tar.gz.

File metadata

  • Download URL: gitnix-1.0.0.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for gitnix-1.0.0.tar.gz
Algorithm Hash digest
SHA256 db1e0fab4bd9c6cb78fdc6bfef390a4c1f1d0633b52a34676d0d596fd8e854d7
MD5 577cf0a893e5f77e22bd9dc16dcdb72b
BLAKE2b-256 2c8524ae9b62e25b7256842dc528f2e4cf2072e6da78b647799f6d421d3fedf3

See more details on using hashes here.

File details

Details for the file gitnix-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: gitnix-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 23.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for gitnix-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e61acc5731c2128afb33ad7d63d6daa544a3234f4620c4ea64ac88801a533786
MD5 f8794dad942fe52770c3893e38530b9d
BLAKE2b-256 5f39f43bc4e1380ea489c03637a30d01182d2b4b987ffd9835ac304f648d196a

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