README.rst
1Xerox: Copy + Paste for Python
2==============================
3
4*Xerox* is a copy + paste module for python. It's aim is simple: to be as incredibly simple as possible.
5
6Supported platforms are currently OS X, X11 (Linux, BSD, etc.), and Windows.
7
8If you can make it simpler, please fork.
9
10Usage
11-----
12
13Usage is as follows: ::
14
15 xerox.copy(u'some string')
16
17And to paste: ::
18
19 >>> xerox.paste()
20 u'some string'
21
22On Linux you can optionally also copy into the X selection clipboard for
23middle-click-paste capability: ::
24
25 xerox.copy(u'Some string', xsel=True)
26
27And you can choose to paste from the X selection rather than the system
28clipboard: ::
29
30 xerox.paste(xsel=True)
31
32And, that's it.
33
34Command Line
35~~~~~~~~~~~~
36To copy: ::
37
38 xerox some string
39
40or: ::
41
42 echo some string | xerox
43
44To paste: ::
45
46 >>> xerox
47 some string
48
49Installation
50------------
51
52To install Xerox, simply:
53
54 $ pip install xerox
55
56Or, if you must:
57
58 $ easy_install xerox
59
60Note: If you are installing xerox on Windows, you will also need to install the pywin32_ module.
61
62Legal Stuff
63-----------
64
65MIT License.
66
67(c\) 2016 Kenneth Reitz.
68
69.. _pywin32: http://sourceforge.net/projects/pywin32/files/
70