send2trash/README.rst

==================================================
Send2Trash -- Send files to trash on all platforms
==================================================

This is a Python 3 package. The Python 2 package is at http://pypi.python.org/pypi/Send2Trash .

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 follows the trash specifications from freedesktop.org.

``ctypes`` is used to access native libraries, so no compilation is necessary.

Installation
------------

Download the source from http://github.com/hsoft/send2trash and install it with::

>>> python setup.py install

Usage
-----

>>> from send2trash import send2trash
>>> send2trash('some_file')

When there's a problem ``OSError`` is raised.
Added README and CHANGES. 2010-04-07 08:43:36 +00:00			`==================================================`
			`Send2Trash -- Send files to trash on all platforms`
			`==================================================`

v1.0.2 --HG-- branch : py3k 2010-07-10 05:06:01 +00:00			`This is a Python 3 package. The Python 2 package is at http://pypi.python.org/pypi/Send2Trash .`

Added README and CHANGES. 2010-04-07 08:43:36 +00:00			`Send2Trash is a small package that sends files to the Trash (or Recycle Bin) natively and on`
v1.2.0 2011-03-16 09:27:41 +00:00			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 follows the trash specifications from freedesktop.org.
Added README and CHANGES. 2010-04-07 08:43:36 +00:00
v1.1.0 --HG-- branch : py3k 2010-10-18 10:13:37 +00:00			``ctypes`` is used to access native libraries, so no compilation is necessary.

Added README and CHANGES. 2010-04-07 08:43:36 +00:00			`Installation`
			`------------`

Updated repo URL to point to GH. 2013-07-19 22:18:16 +00:00			`Download the source from http://github.com/hsoft/send2trash and install it with::`
Added README and CHANGES. 2010-04-07 08:43:36 +00:00
v1.1.0 --HG-- branch : py3k 2010-10-18 10:13:37 +00:00			`>>> python setup.py install`
Added a setuptools-crappiness notice in the README. --HG-- branch : py3k extra : transplant_source : %F8%9A%02%C3%D2%AA%AB%2C%5D%94%EA%13%BD%D6%A0U%3F%D2N%C9 2010-07-13 10:19:19 +00:00
Added README and CHANGES. 2010-04-07 08:43:36 +00:00			`Usage`
			`-----`

			`>>> from send2trash import send2trash`
			`>>> send2trash('some_file')`

			When there's a problem ``OSError`` is raised.