Skip to main content

Simple module for easily isolating temporary file I/O

Project description

Latest Version Travis-ci build status Coveralls test coverage

A simple module for easily isolating temporary file I/O to a directory. Ever developed a command-line tool which required a lot of file manipulation? Caching, perhaps? You don’t want to use the cwd and keeping all of your paths straight if you’re working outside of it can be a pain. This tool may be the pain-reliever you need!

A tale of sin and woe

Well, not really. I’ve just developed a bunch of tools that rely on various bits of temporary or isolated file I/O, and found myself implementing this pattern over and over again. Eventually, I got tired of doing it and decided to develop this handy module. Now I’m passing the savings on to you!

Compatibility

As far as I know, workdir is compatible with every version of Python from 2.6 through 3.5. It should also be compatible with all major platforms including Linux, OSX, and Windows. If not, let me know!

Installation

pip install workdir

Examples

Use it as a staging area for downloaded archives:

import workdir
import shutil
workdir.options.path = '~/.myfilecache'
with workdir.as_cwd():
    download_remote_archive('somefile')
    unpack_archive('somefile', 'somedir')
shutil.copy(workdir.path_to_file('somedir', 'unpackedfilefromarchive'),
            os.path.join('otherdir', 'unpackedfilefromarchive'))

Use it as a working directory in your git repo (added to .gitignore, of course):

import workdir
workdir.options.path = '.gitrepo.work'
workdir.sync()
with workdir.as_cwd():
    futz_with_source_tree()
    more_futzing()

Project details


Release history Release notifications

This version
History Node

0.3.5

History Node

0.3.3

History Node

0.3.2

History Node

0.3.1

History Node

0.3

History Node

0.2

History Node

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
workdir-0.3.5-py2.py3-none-any.whl (3.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3 May 17, 2016
workdir-0.3.5.tar.gz (3.7 kB) Copy SHA256 hash SHA256 Source None May 17, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page