docstash

A simple mechanism for storing a (potentially large) set of immutable documents in an organized way. Metadata is stored along with the data as a YAML file.

docstash is inspired by OFS, BagIt and Pairtree.

Installation

The easiest way of using docstash is via PyPI:

$ pip install docstash

Alternatively, check out the repository from GitHub and install it locally:

$ git clone https://github.com/pudo/docstash.git
$ cd docstash
$ python setup.py develop

Example

docstash manages Documents which are part of a Collection, which in turn is part of a Stash. The location of the main stash can be considered a per-user setting, it can be shared by applications using this library.

from docstash import Stash

# open a stash in the current working directory:
stash = Stash(path='.stash')

# print a list of collections:
print list(stash)

# access (or create) a specific collection:
collection = stash.get('test')

# import a file from the local working directory:
collection.ingest('README.md')

# import an http resource:
collection.ingest('http://pudo.org/index.html')
# ingest will also accept file objects and httplib/urllib/requests responses

# iterate through each document and set a metadata
# value:
for doc in collection:
    with open(doc.file, 'rb') as fh:
        doc['body_length'] = len(fh.read())
    doc.save()

The code for this library is very compact, go check it out.

Configuration

The storage directory for the stash is an optional value. If it isn't passed in (or if it is None), the value of the environment variable DOCSTASH_PATH will be used. If that variable is unused, docstash will default to ~/.docstash.

License

docstash is open source, licensed under a standard MIT license (included in this repository as LICENSE).