Browse Source

Added README and CHANGES.

pull/6/head
Virgil Dupras 11 years ago
parent
commit
aff05287b3
  1. 4
      CHANGES
  2. 25
      README
  3. 2
      setup.py

4
CHANGES

@ -0,0 +1,4 @@
Version 1.0.0 -- 2010/04/07
---
* Initial Release

25
README

@ -0,0 +1,25 @@
==================================================
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, it moves the file to the first folder it finds that looks like a trash (so far, it's known to work on Ubuntu).
Installation
------------
Download the source from http://hg.hardcoded.net/send2trash and install it with::
>>> sudo python setup.py install
On Windows, you'll need Visual Studio 2008 to compile it. Note that the install you'll get will not be a "universal" package. If you install it on OS X, only the "osx" module will be compiled, and if you install it on Windows, only the "win" module will be compiled.
To have a cross-platform package you can ship around, you'll have compile the package on both platforms and merge the results so that both compiled modules are in the same package.
Usage
-----
>>> from send2trash import send2trash
>>> send2trash('some_file')
When there's a problem ``OSError`` is raised.

2
setup.py

@ -27,7 +27,7 @@ setup(
packages=['send2trash'],
scripts=[],
ext_modules = exts,
url='http://www.hardcoded.net/docs/send2trash/',
url='http://hg.hardcoded.net/send2trash/',
license='LICENSE',
description='Send file to trash natively under Mac OS X, Windows and Linux.',
)
Loading…
Cancel
Save