From aff05287b3d0a16489238fca2021367ea49ab02b Mon Sep 17 00:00:00 2001 From: Virgil Dupras Date: Wed, 7 Apr 2010 10:43:36 +0200 Subject: [PATCH] Added README and CHANGES. --- CHANGES | 4 ++++ README | 25 +++++++++++++++++++++++++ setup.py | 2 +- 3 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 CHANGES create mode 100644 README diff --git a/CHANGES b/CHANGES new file mode 100644 index 0000000..32b5118 --- /dev/null +++ b/CHANGES @@ -0,0 +1,4 @@ +Version 1.0.0 -- 2010/04/07 +--- + +* Initial Release \ No newline at end of file diff --git a/README b/README new file mode 100644 index 0000000..2d71a06 --- /dev/null +++ b/README @@ -0,0 +1,25 @@ +================================================== +Send2Trash -- Send files to trash on all platforms +================================================== + +Send2Trash is a small package that sends files to the Trash (or Recycle Bin) *natively* and on +*all platforms*. On OS X, it uses native ``FSMoveObjectToTrashSync`` Cocoa calls, on Windows, it uses native (and ugly) ``SHFileOperation`` win32 calls. On other platforms, it moves the file to the first folder it finds that looks like a trash (so far, it's known to work on Ubuntu). + +Installation +------------ + +Download the source from http://hg.hardcoded.net/send2trash and install it with:: + +>>> sudo python setup.py install + +On Windows, you'll need Visual Studio 2008 to compile it. Note that the install you'll get will not be a "universal" package. If you install it on OS X, only the "osx" module will be compiled, and if you install it on Windows, only the "win" module will be compiled. + +To have a cross-platform package you can ship around, you'll have compile the package on both platforms and merge the results so that both compiled modules are in the same package. + +Usage +----- + +>>> from send2trash import send2trash +>>> send2trash('some_file') + +When there's a problem ``OSError`` is raised. \ No newline at end of file diff --git a/setup.py b/setup.py index e66d14f..8b38ad0 100644 --- a/setup.py +++ b/setup.py @@ -27,7 +27,7 @@ setup( packages=['send2trash'], scripts=[], ext_modules = exts, - url='http://www.hardcoded.net/docs/send2trash/', + url='http://hg.hardcoded.net/send2trash/', license='LICENSE', description='Send file to trash natively under Mac OS X, Windows and Linux.', ) \ No newline at end of file