Metadata-Version: 1.1
Name: keeper
Version: 0.96.1
Summary: A file-based value store for bytes and strings.
Home-page: https://github.com/rob-smallshire/keeper/
Author: Robert Smallshire
Author-email: robert@smallshire.org.uk
License: MIT License
Download-URL: https://github.com/rob-smallshire/keeper/archive/master.zip
Description: ======
        keeper
        ======
        
        Keeper is a filesystem-based, content-addressable value store for Python 3.
        
        Installation
        ============
        
          $ pip install keeper
        
        
        Using Keeper
        ============
        
        Pass a directory path to a Keeper instance::
        
           from keeper import Keeper
        
           with Keeper("/some/directory/") as k:
               ...
        
        Add string or bytes objects, and get a key in return::
        
               key = self.keeper.add("The quick brown fox jumped over the lazy dog")
        
        Use the key to retrieve the string::
        
               value = keeper[key].as_string()
        
        
        Add another string with some metadata::
        
               key = keeper.add(text, mime="text/plain", filename="foo.txt", author="Joe Bloggs")
        
        Retrieve metadata::
        
               print(keeper[key].meta.mime)
        
        
        Add a stream you can write to::
        
               with keeper.add_stream() as stream:
                    stream.write(b'A large number of bytes')
        
        After the stream has closed, retrieve the key::
        
               key = stream.key
        
        
        Deployment
        ==========
        
        
          $ python setup.py sdist bdist_wheel
          $ twine upload dist/*
        
        
        
Keywords: Python
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
