Skip to main content

Vault

Vault is a flexible and lightweight data/file storage, retrieval, and caching system for Python applications.

It enables developers to manage any Python object (given a proper Datatype implementation), store them locally or remotely, organize them by type, and access them efficiently using an in-memory cache, all this with just a few lines of code.

Vault has only two dependencies (psutil and requests), encourages memory usage monitoring, and will support non-blocking I/O operations.

I. Project Structure

Vault is split into two libraries:

  • vault – Core data storage library, which also includes the ability to connect to remote Vaults.
  • vault-fastapi – Library for building custom servers that expose Vault storage over the network.

There are also two usage examples: one for local use-cases where Vault is used within the same Python process, and one for remote use-cases where Vault is run on a separate machine.

Additionally, the datatypes/ directory contains example wrappers for using Python types from common libraries with Vault.

II. Architecture

(todo)

Diagram for showing the core in-memory cache for accessing data

III. Milestones

A main issue with Vault is the absence of ways to scale Vaults across multiple servers: those issue will be solved with Vault 2.0, which will introduce Scalable Storage, Disk Caching and Data Streaming.

These changes are intended to support large-scale applications and will likely require breaking changes; we are planning to recieve feedback and fix bugs during the 1.0 development cycle in order to have a stable base to build upon, before starting the 2.0 development cycle.

Before that, a key improvement planned for 1.x is support for non-blocking data operations, either through async-compatible methods for the already implement classes or async-specific variants of existing classes.

A smaller improvement that could be done for programs that use large amounts of files is adding an optional feature for keeping track of files in a separate register (most likely sqlite) in order to remove the need to list all files in the directories when the Vault is loaded. This additional database could also be used to add data integrity checks (checksum).

IV. Vault API

The Remote API specification for Vault 1.0 is available in VAULT_API.md.

Metadata

Release files for pyvault-client 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyvault-client 0.1.1
File Size Uploaded Provenance Actions
pyvault_client-0.1.1.tar.gz 19.5 kB Without provenance Details for pyvault_client-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyvault-client 0.1.1
File Interpreter ABI Platform Actions
pyvault_client-0.1.1-py3-none-any.whl Python 3 none any Details for pyvault_client-0.1.1-py3-none-any.whl

Total release size: 39.0 kB

Release files / pyvault_client-0.1.1.tar.gz

Download URL pyvault_client-0.1.1.tar.gz
Size 19.5 kB
Tags Source
SHA-256 checksum
How to use checksums
0afa05a15d3b464987baf298d8f0f04f2b4a319daa14ed60b1f2a344e27b984a
BLAKE2b-256 checksum
How to use checksums
a3dc39162bbff2a39ca658a2a7ccab7709d21b3df49bc9b89fe21beec99d3ae3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Release files / pyvault_client-0.1.1-py3-none-any.whl

Download URL pyvault_client-0.1.1-py3-none-any.whl
Size 19.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fb7ce660b89c30c4ece607bb0c855e091b1f1256fdee5c4561bbdfaee2ecfc72
BLAKE2b-256 checksum
How to use checksums
2331ad64af9492b3c81e42e0afae95191dc2737e59bb6f5b6a78f97d178d081e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.9

Security for pyvault-client 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page