arsenetar
/
send2trash
mirror of https://github.com/arsenetar/send2trash.git
1
0
Fork 0
Code Releases Activity
113 Commits 2 Branches 17 Tags 449 KiB
Python 100%
Go to file
Andrew Senetar 356509120b
Add some checks to catch test failure 
Really just checking that the setup is able to create test files so it
is known they were there then removed.
Windows tests really need verification of
recycle, which is not present.
 		2021-03-17 20:52:16 -05:00
send2trash Fix legacy windows platform for multibyte unicode 2021-03-10 21:41:30 -06:00
tests Add some checks to catch test failure 2021-03-17 20:52:16 -05:00
.gitignore Fix some flake8 errors and cleanup 2020-06-18 21:47:06 -05:00
.travis.yml More test fixes 2021-03-10 18:57:35 -06:00
CHANGES.rst Update files to release a new package 2020-06-18 21:49:42 -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 Expand supported Python versions 2020-12-01 09:16:20 +01:00
setup.py Add console_script entry point, close #50 2021-01-12 18:22:23 -06:00
tox.ini Update Tox and Travis configurations 2021-03-02 00:24:59 -06: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 ``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

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/