mirror of
				https://github.com/arsenetar/send2trash.git
				synced 2025-09-11 18:08:16 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			37 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
			
		
		
	
	
			37 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			ReStructuredText
		
	
	
	
	
	
==================================================
 | 
						|
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/
 |