arsenetar/send2trash
1
0
Fork 0
mirror of https://github.com/arsenetar/send2trash.git synced 2026-01-22 14:41:40 +00:00
Code Releases Activity

Renamed README --> README.rst

Browse Source
This commit is contained in:
Virgil Dupras
2013-07-19 18:14:27 -04:00
parent f7a6f217ce
commit 8996fb9eac
1 changed files with 0 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.rst Normal file
View File

@@ -0,0 +1,25 @@
==================================================
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://hg.hardcoded.net/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.