Skip to main content

filevault

filevault is a class for managing a hash directory tree of files on a filesystem.

A Vault will:

  • Create a hash directory tree of custom depth

  • Spread out files to keep CLI snappy when traversing the tree

  • Scale to hundreds of thousands of files

  • Obfuscate directory paths and filenames

how to install

Setuptools:

easy_install filevault

Pip:

pip install filevault

how to use

How to create a default Vault object:

from filevault import Vault

v = Vault()

You may (and should) customize the Vault instance. Here are the arguments:

vaultpath

Where should the tree be created? Defaults to ‘vault’ in pwd.

depth

How deep should the tree span? Defaults to 3 directories deep.

salt

Add a custom salt for a unique and more secure tree, defaults to ‘changeme’

Another custom example:

from filevault import Vault

v = Vault( vaultpath="/tmp/for-test", depth=2, salt="sugar" )

Now that we have a Vault object named v, we may review its three methods:

create_filename( seed, ext=’’ )

Create a valid vault filename seeded with input. Optional extension.

create_absolute_filename( seed, ext=’’ )

Create a valid vault absolute filename seeded with input. Optional extension.

create_random_filename( ext=’’ )

Create a valid vault filename seeded with random input. Optional extension.

Here is a full example:

# import Vault class
from filevault import Vault

# create vault object named v, with custom path, depth, and salt
v = Vault( vaultpath="/tmp/for-test", depth=2, salt="sugar" )

# print a valid vault filename with extension
print v.create_filename( "my-first-file", ".png" )

# result:
# 3/9/3993817d4f9b3867c6db29b23c9d2ff9bb8a87d89426002adbb6ed34289d9e32.png

print v.create_filename( "my-first-file", ".png" )

# Same result:
# 3/9/3993817d4f9b3867c6db29b23c9d2ff9bb8a87d89426002adbb6ed34289d9e32.png

# print a valid vault absolute filename with extension
print v.create_absolute_filename( "my-first-file", ".png" )

# result:
# /tmp/for-test/3/9/3993817d4f9b3867c6db29b23c9d2ff9bb8a87d89426002adbb6ed34289d9e32.png


# print a random valid vault filename without extension
v.create_random_filename()

# result:
# 6/1/6169d6ee0ac0bc63ab667fb94d9cc747df0c03596ac43e24a51b3517d74bdc42

how may I thank you?

Check out my webpage to screenshot service and give me some feedback, tips, or advice. Every little bit of help counts.

Metadata

Release files for filevault 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 filevault 0.1.1
File Size Uploaded Provenance Actions
filevault-0.1.1.tar.gz 2.7 kB Without provenance Details for filevault-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for filevault 0.1.1
File Interpreter ABI Platform Actions
filevault-0.1.1-py2.7.egg Legacy Egg format - - Details for filevault-0.1.1-py2.7.egg

Total release size: 6.5 kB

Release files / filevault-0.1.1.tar.gz

Download URL filevault-0.1.1.tar.gz
Size 2.7 kB
Tags Source
SHA-256 checksum
How to use checksums
fc6090072c4949597fe28feda29ba448d471ae8ebcf4cd05f3ce41cfead38b75
BLAKE2b-256 checksum
How to use checksums
fd1d81fb07c4afad96d43de5eac2e54fcf136b0b9d51f50b8737d2146c491354
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / filevault-0.1.1-py2.7.egg

Download URL filevault-0.1.1-py2.7.egg
Size 3.7 kB
Tags Egg
SHA-256 checksum
How to use checksums
bbdf5d2af5528e7cd0c9e082c57e4d183cb8f4b8393a51112790f93c99065c9f
BLAKE2b-256 checksum
How to use checksums
44b5637136ba763676f4959161a04cd5f819aee5d76548d174833dbf9e2c44ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for filevault 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.

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