Metadata-Version: 2.0
Name: tempstore
Version: 1.0.4
Summary: A simple container for handling multiple tempfiles
Home-page: https://github.com/ryanrichholt/tempstore
Author: Ryan Richholt
Author-email: UNKNOWN
License: UNKNOWN
Description-Content-Type: UNKNOWN
Keywords: temp tempfile tempdir
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Utilities

tempstore
=========

A simple container for handling multiple tempfiles

Example:

.. code:: shell

    >>> import tempstore
    >>> s = tempstore.TempStore('somedata')
    >>> s.create('banana')
    '/var/folders/ng/c57k6x7n1qn9f6hw_hw4zrlcnxhmy8/T/tmpsvzuj4bd/tmp3gh1vid9'
    >>> s.copy('./')
    >>> s.cleanup()
    >>>

tempstore.TempStore(name=None)
------------------------------

Create a new TempStore.

TempStore.create(name)
----------------------

Create a new tempfile. This returns the path to the tempfile, and it can
be accessed again later with either ``TempStore.paths[name]`` or
``TempStore.objs[name].name``.

TempStore.paths
---------------

Access the paths of items in the ``TempStore``

TempStore.objs\`
----------------

Access the ``tempfile.NamedTemporaryFile`` objects of items in the
``TempStore``

TempStore.cleanup()
-------------------

Remove all the temporary files in the ``TempStore``

TempStore.copy(path=None, exist_ok=True)
----------------------------------------

Copy all items in the ``TempStore`` to a given path. If
``TempStore.name`` is not None, a new directory will be created in
``path`` with the name, and all files will be copied there.

``exist_ok`` will be passed to ``os.makedirs`` if TempStore.name is not
None


