Go to file
Virgil Dupras 016b90c1ac Update copyright 2017-08-03 20:52:19 -04:00
send2trash Update copyright 2017-08-03 20:52:19 -04:00
tests Properly reuse the "compat" unit 2017-08-03 20:47:58 -04:00
.gitignore Fix tests, add tox.ini and travis.yml 2017-08-03 20:34:10 -04:00
.travis.yml Fix tests, add tox.ini and travis.yml 2017-08-03 20:34:10 -04:00
CHANGES.rst v1.3.1 2017-07-31 14:21:18 -04:00
LICENSE Update copyright 2017-08-03 20:52:19 -04:00
MANIFEST.in Add same-codebase support for python 2.7. 2013-07-19 18:42:32 -04:00
README.rst v1.3.0 2013-07-19 19:26:34 -04:00
setup.py Fix tests, add tox.ini and travis.yml 2017-08-03 20:34:10 -04:00
tox.ini Fix tests, add tox.ini and travis.yml 2017-08-03 20:34:10 -04:00

README.rst

==================================================
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, if `PyGObject`_ and
`GIO`_ are available, it will use this.  Otherwise, it will fallback to its own implementation
of the `trash specifications from freedesktop.org`_.

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

Send2Trash supports Python 2.7 and up (Python 3 is supported).

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

You can download it with pip::

    pip install Send2Trash

or you can 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.

.. _PyGObject: https://wiki.gnome.org/PyGObject
.. _GIO: https://developer.gnome.org/gio/
.. _trash specifications from freedesktop.org: http://freedesktop.org/wiki/Specifications/trash-spec/