Commits

Jason R. Coombs committed 0c1c215

updated with description and long_description

Comments (0)

Files changed (2)

+yg.lockfile
+===========
+
+A LockFile class that implements a context manager with timeouts on top of
+`zc.lockfile`, an excellent, cross-platorm implementation of file locking.
+
+Usage
+-----
+
+Example usage::
+
+    import yg.lockfile
+    try:
+    	with yg.lockfile.LockFile('/tmp/lockfile', timeout=900):
+    		protected_operation()
+    except yg.lockfile.LockFileTimeout:
+    	handle_unable_to_lock()
 # Generated by jaraco.develop (https://bitbucket.org/jaraco/jaraco.develop)
 import setuptools
 
+with open('README.rst') as readme:
+	long_description = readme.read()
+
 setup_params = dict(
 	name='yg.lockfile',
 	use_hg_version=True,
 	author="Jason R. Coombs",
 	author_email="jaraco@jaraco.com",
+	description="Lockfile object with timeouts and context manager",
+	long_description=long_description,
 	url="https://bitbucket.org/jaraco/yg.lockfile",
 	packages=setuptools.find_packages(),
 	namespace_packages=['yg'],
-	zip_safe=False,
+	zip_safe=True,
 	setup_requires=[
 		'hgtools',
 	],
+	install_requires=[
+		'zc.lockfile',
+	],
 )
 if __name__ == '__main__':
 	setuptools.setup(**setup_params)