1
0
mirror of https://github.com/arsenetar/send2trash.git synced 2024-11-01 22:35:57 +00:00
Go to file
2018-01-06 08:19:31 -05:00
send2trash Workaround embedded null character (#18) 2017-11-01 08:28:22 -04:00
tests Reindent test_plat_other 2017-08-03 21:03:34 -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.4.2 2017-11-17 13:50:29 -05:00
LICENSE Update copyright 2017-08-03 20:52:19 -04:00
MANIFEST.in Include LICENSE in package (#19) 2018-01-06 08:19:31 -05:00
README.rst v1.3.0 2013-07-19 19:26:34 -04:00
setup.py v1.4.2 2017-11-17 13:50:29 -05:00
tox.ini Fix tests, add tox.ini and travis.yml 2017-08-03 20:34:10 -04:00

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