Go to file
Virgil Dupras fa68152b35 Added tag 1.0.0 for changeset 48c2103380f5 2010-04-07 13:16:55 +02:00
modules Added missing sentinel in osx module's method defs. 2010-04-07 13:16:51 +02:00
send2trash Licensed under BSD. 2010-04-07 08:52:24 +02:00
.hgignore Renamed _trash_* modules to _send2trash_* and added python wrapper around them. 2010-04-06 18:04:32 +02:00
.hgtags Added tag 1.0.0 for changeset 48c2103380f5 2010-04-07 13:16:55 +02:00
CHANGES Added README and CHANGES. 2010-04-07 10:43:36 +02:00
LICENSE Licensed under BSD. 2010-04-07 08:52:24 +02:00
README Added README and CHANGES. 2010-04-07 10:43:36 +02:00
setup.py Added README and CHANGES. 2010-04-07 10:43:36 +02:00

README

==================================================
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.