Go to file
Andrew Senetar 0ef9b3294a
fix(tests): Correct windows tests to run on python <3.6
2022-07-26 22:51:16 -05:00
.github/workflows Create codeql-analysis.yml 2021-08-18 02:26:10 -05:00
send2trash fix(win): Prevent exception on empty list 2022-07-26 22:42:30 -05:00
tests fix(tests): Correct windows tests to run on python <3.6 2022-07-26 22:51:16 -05:00
.gitignore Fix some flake8 errors and cleanup 2020-06-18 21:47:06 -05:00
.travis.yml Remove Python 3.4 2021-08-19 21:01:55 -05:00
CHANGES.rst Update version & changelog for 1.8.1b0 2021-08-20 22:42:04 -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 Change extra requires to filter on platform 2021-08-07 21:04:40 -05:00
pyproject.toml Update to use pyproject.toml & setup.cfg 2021-08-17 18:53:56 -05:00
setup.cfg Update setup.cfg for changes in d37197c, fix #68. 2022-06-01 02:06:14 -05:00
tox.ini Update tox config 2021-08-19 20:46:02 -05: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 or can use pyobjc 
with NSFileManager. On Windows, it uses native ``IFileOperation`` call if on Vista or newer and 
pywin32 is installed or falls back to ``SHFileOperation`` 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).

Status: Additional Help Welcome
-------------------------------

Additional help is welcome for supporting this package.  Specifically help with the OSX and Linux 
issues and fixes would be most appreciated.

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

You can download it with pip:

    python -m pip install -U send2trash

To install with pywin32 or pyobjc required specify the extra `nativeLib`:

    python -m pip install -U send2trash[nativeLib]

or you can download the source from http://github.com/arsenetar/send2trash and install it with::

    >>> python setup.py install

Usage
-----

>>> from send2trash import send2trash
>>> send2trash('some_file')
>>> send2trash(['some_file1', 'some_file2'])

On Freedesktop platforms (Linux, BSD, etc.), you may not be able to efficiently
trash some files. In these cases, an exception ``send2trash.TrashPermissionError``
is raised, so that the application can handle this case. This inherits from
``PermissionError`` (``OSError`` on Python 2). Specifically, this affects
files on a different device to the user's home directory, where the root of the
device does not have a ``.Trash`` directory, and we don't have permission to
create a ``.Trash-$UID`` directory.

For any other 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/