Diff of /readme.txt [fa04f8] .. [09cb6c] Maximize Restore

  Switch to unified view

a/readme.txt b/readme.txt
...
...
18
License and Contact information
18
License and Contact information
19
-------------------------------
19
-------------------------------
20
http://pype.sourceforge.net
20
http://pype.sourceforge.net
21
http://come.to/josiah
21
http://come.to/josiah
22
22
23
PyPE is copyright 2003-2006 Josiah Carlson.
23
PyPE is copyright 2003-2010 Josiah Carlson.
24
Contributions are copyright their respective authors.
24
Contributions are copyright their respective authors.
25
25
26
This software is licensed under the GPL (GNU General Public License) version 2
26
This software is licensed under the GPL (GNU General Public License) version 2
27
as it appears here: http://www.gnu.org/copyleft/gpl.html
27
as it appears here: http://www.gnu.org/copyleft/gpl.html
28
It is also included with this archive as `gpl.txt <gpl.txt>`_.
28
It is also included with this archive as `gpl.txt <gpl.txt>`_.
...
...
47
Requirements
47
Requirements
48
------------
48
------------
49
49
50
Either a machine running Python and wxPython, or a Windows machine that can
50
Either a machine running Python and wxPython, or a Windows machine that can
51
run the binaries should be sufficient.  Initial revisions of PyPE were
51
run the binaries should be sufficient.  Initial revisions of PyPE were
52
developed on a PII-400 with 384 megs of ram, but it should work on any machine
52
developed on a PII-400 with 384 megs of ram, but modern versions have been
53
written with more modern machines.  Really, PyPE should work on any machine
53
that can run the most recent wxPython revisions.  Some portions may be slow
54
that can run the most recent wxPython revisions.  Some portions may be slow
54
(when using Document->Wrap Long Lines especially, which is a known issue with
55
(when using Document->Wrap Long Lines especially, which is a known issue with
55
the scintilla text editor control), but it should still be usable.
56
the scintilla text editor control in wxPython 2.8.*), but it should still be
57
usable.
56
58
57
PyPE 2.x has been tested on Python 2.3 and wxPython 2.6.3.0.  It should work
59
PyPE is usually only tested on my dev machine, which is currently a Windows 7
58
on later versions of Python and wxPython.  If you are having issues, file a
60
64-bit machine running 32 bit Python 2.6 with a somewhat recent wxPython 2.8.
61
If you run into issues, please feel free to file a bug report on
59
bug report on http://sourceforge.net/projects/pype .
62
http://sourceforge.net/projects/pype/ .
63
64
As this document doesn't get updated all that often, please be aware that
65
these version numbers may change during PyPE development.  If those revisions
66
of Python or wxPython are out-of-date with the bleeding edge of both pieces of
67
software (currently Python 2.7/3.1 and wxPython 2.9.x) either I've not tested
68
PyPE on those revisions, or I have, and I've not updated this document.  PyPE
69
has not been translated for use with Python 3.x, so it won't work.  When PyPE
70
supports Python 3.x, there will be a notification and there will be a special
71
version.
60
72
61
------------
73
------------
62
Installation
74
Installation
63
------------
75
------------
64
76
65
If you have Python 2.3 or later as well as wxPython 2.6.3 or later, you can
77
If you have Python 2.6+ and wxPython 2.8+, you should be able to extract the
66
extract PyPE-X.Y.Z-src.zip anywhere and run it by double-clicking on pype.py
78
most recent PyPE-X.Y.Z-src.zip anywhere, and if your associations are set up
67
or pype.pyw .  Note that the 2.6.3.3 ansi build of wxPython has issues with
79
correctly, run it by double-clicking on pype.py or pype.pyw .
68
pasting, so use some other ansi build, or even the 2.6.3.3 unicode build.
69
80
70
If you don't have Python 2.3 wxPython 2.6.3 or later, and are running Windows,
81
If you don't have Python or wxPython installed on your system, and are using
71
you should (hopefully) be able to run the Windows binaries.  They are provided
82
Windows, you may try to run a recent Windows binary.  They are provided for
72
for your convenience (so you don't have to install Python and wxPython).
83
your convenience, so if they don't work, please file a bug report.
73
84
74
At the current time, the Windows binaries are constructed with Python 2.3 and
75
wxPython 2.6.3.0 .  I have considered moving to Python 2.5 or even 2.4 with
76
wxPython 2.8, but switching to Python 2.4 with wxPython 2.6.x adds 700k to the
77
binary distribution, and going with Python 2.5 and wxPython 2.8 (there are
78
currently no wxPython 2.6.3.* releases for Python 2.5) adds 2.2 megs to the
79
binary distribution, some of which is the Python 2.4-2.5 size difference, much
80
of it being the necessity to include the gdi plus dll for non-XP/Vista
81
platforms, and even the MSVC 7.1 runtime.  While many users have copies of
82
both of these runtimes *somewhere* on their system, PyPE cannot rely on them
83
being accessable (on my machine only the MSVC 7.1 runtime is in a system path,
84
while the gdi plus dll is in about a dozen places).
85
86
If it so happens that the Windows binaries don't work for you, and you have an
87
installation of Python and wxPython that fits the requirements, why don't you
88
run the source version?  The only difference is a pass through py2exe, and a
89
minor loading time speed increase.  Just because the Windows binaries exist,
90
doesn't mean that you /have/ to run them.  If you have a Python and wxPython
91
installation, you should have the necessary dlls to make PyPE run (Python is
92
shipped with the 7.1 runtime, and wxPython 2.7+ ships with the gdi plus dll).
93
85
94
Why doesn't the Windows install work?
86
Why doesn't the Windows install work?
95
=====================================
87
=====================================
96
Depending on your platform, it may or may not work.  It works for me on
88
Depending on your platform, it may or may not work.  Most problems people have
97
Windows 2k and XP.  Most problems people have is that they mistakenly extract
89
is that they mistakenly extract library.zip, which they shouldn't do (and in
98
library.zip, which they shouldn't do (and in recent PyPE binary releases
90
recent PyPE binary releases may not be able to do).  It could also be due to
99
may not be able to do).  It could also be due to the lack of some DLL, in
91
the lack of some DLL, in which case an error message should inform you of
100
which case an error message should inform you of which DLL you are missing.
92
which DLL you are missing.  PyPE 2.9.1 for Windows was missing msvcp71.dll
93
file, which will be included with subsequent Windows releases.
101
94
102
95
103
Why doesn't PyPE work on Linux?
96
Why doesn't PyPE work on Linux?
104
===============================
97
===============================
105
PyPE 2.5+ has been tested on Ubuntu 6.06 with...
98
If you aren't running a LTS version of Ubuntu (currently 10.4), I probably
106
99
have not tested PyPE on your particular flavor of Linux.  Assuming that you
107
* python-wxversion_2.6.1.2ubuntu2_all.deb
100
can download and run the wxPython demo from the "wxPython Docs and Demos"
108
101
available from http://www.wxpython.org, then PyPE should also work.
109
* libwxgtk2.6-0_2.6.1.2ubuntu2_i386.deb
110
111
* python-wxgtk2.6_2.6.1.2ubuntu2_i386.deb
112
113
And 
114
115
* libwxgtk2.7-0_2.7.1.3-0_i386.deb
116
117
* python-wxgtk2.7_2.7.1.3-0_i386.deb
118
119
The only anomalies observed so far is seemingly a bug with some
120
wx.ScrolledPanel uses (which have been replaced in more recent releases), and
121
when using a pure Kubuntu install (installed via the Kubuntu install, and not
122
Ubuntu + Kubuntu core via synaptic), there may be errors and/or warnings
123
during PyPE startup.  I have not been able to crash PyPE yet, so I presume it
124
is stable.  I have recently switched to using Ubuntu + Kubuntu core + Xubuntu
125
core, and I haven't noticed any of aforementioned errors.
126
102
127
There have previously been reports of PyPE segfaulting in certain Linux
103
There have previously been reports of PyPE segfaulting in certain Linux
128
distributions when opening a file.  This seems to be caused by icons in the
104
distributions when opening a file.  This seems to be caused by icons in the
129
file listing in the 'Documents' tab on the right (or left) side of the editor
105
file listing in the 'Documents' tab on the right (or left) side of the editor
130
(depending on your preferences), or by icons in the notebook tabs along the
106
(depending on your preferences), or by icons in the notebook tabs along the
...
...
134
that it is unchecked.  You should restart PyPE to make sure that the setting
110
that it is unchecked.  You should restart PyPE to make sure that the setting
135
sticks.  PyPE will be uglier, but it should work.  I believe that this has
111
sticks.  PyPE will be uglier, but it should work.  I believe that this has
136
been fixed in PyPE 2.4.1 and later, but this documentation persists "just in
112
been fixed in PyPE 2.4.1 and later, but this documentation persists "just in
137
case".
113
case".
138
114
115
If you run into other errors, please file a bug report at
116
http://sourceforge.net/projects/pype/ .
117
139
118
140
Why isn't the most recent PyPE available as deb or RPM?
119
Why isn't the most recent PyPE available as deb or RPM?
141
=======================================================
120
=======================================================
142
Short answer: it's a pain in the ass.
121
Short answer: it's a pain in the ass.
143
122
...
...
160
to rpm packages.
139
to rpm packages.
161
140
162
141
163
Why doesn't PyPE work on OSX?
142
Why doesn't PyPE work on OSX?
164
=============================
143
=============================
165
Aside from "PyPE works on OSX" (or "almost works") from 2 users, I don't know
144
PyPE 2.9.1 was released with some OSX-specific optimizations to make my life
166
what may be causing PyPE to not work in OSX.  If you send bug reports with
145
using PyPE on OSX better.  At the time, I had been using OSX with work, which
167
tracebacks, etc., we can probably figure out what is going on and how we can
146
was an experiment that lasted only 2 1/2 months, due in part to PyPE's
168
fix it.
147
slowness at the time on OSX.  This is caused by OSX shenanigans WRT the layers
148
that go into rendering GTK on OSX.
169
149
170
In the summer of 2008, I actually had an OS X laptop to use mid June 2008 to
150
Since I don't have an OSX machine on which to run PyPE, I'm at the mercy of
171
late August 2008.  I did my best to improve PyPE, but because of how slow PyPE
151
those on the system to file bug reports and test my bug fixes.  PyPE works
172
is on OS X (I believe it is caused by the way the editor control is wrapped on
152
well on Linux, Windows, and within a Windows VM on OSX (where it's actually
173
OS X with wxPython), I actually abandoned the platform.  PyPE inside an Ubuntu
153
faster than in OSX native).
174
or Windows virtual machine (Virtual Box or Parallels are both good) works
175
well on OS X.
176
154
177
--------------------
155
--------------------
178
Command Line Options
156
Command Line Options
179
--------------------
157
--------------------
180
158
...
...
453
431
454
2. When the cursor is in a non-indent portion of a line, and you paste, Smart
432
2. When the cursor is in a non-indent portion of a line, and you paste, Smart
455
   Paste will automatically paste to the next line, indenting one level deeper
433
   Paste will automatically paste to the next line, indenting one level deeper
456
   as necessary if you had selected the start of a new block (like if, for,
434
   as necessary if you had selected the start of a new block (like if, for,
457
   while, def, etc., for Python, open curly braces '{' in C, etc.).
435
   while, def, etc., for Python, open curly braces '{' in C, etc.).
436
437
438
What is Middle Paste?
439
=====================
440
PyPE 2.9.3 and later now supports Unix-style selection + middle clicking on
441
OSX and Linux.  Windows versions of PyPE have it as an optional feature for
442
use within PyPE only.  These features are derived from Robert McMullen's post:
443
http://goo.gl/zXsN2 .
458
444
459
445
460
What do the different options in the Filter tool do?
446
What do the different options in the Filter tool do?
461
====================================================
447
====================================================
462
448
...
...
1300
wouldn't have had some of the great inspiration that IDLE has offered.  IDLE
1286
wouldn't have had some of the great inspiration that IDLE has offered.  IDLE
1301
is a wonderful editor, has some excellent ideas in terms of functionality, but
1287
is a wonderful editor, has some excellent ideas in terms of functionality, but
1302
unfortunately does not offer the extended functionality I want, and it hurts
1288
unfortunately does not offer the extended functionality I want, and it hurts
1303
my brain to use tk, so I cannot add it myself.
1289
my brain to use tk, so I cannot add it myself.
1304
1290
1291
Robin Dunn - without Robin Dunn spending countless hours wrapping and building
1292
Pythonic APIs, I'm not sure that PyPE could have come to be.  Most of the
1293
other GUI libraries I was looking at the time for doing PyPE development have
1294
fallen behind, and/or stopped being maintained. Robin deserves more thanks
1295
than I could possibly express in this blurb.
1296
1305
The people writing wxWidgets (previously named wxWindows) and wxPython -
1297
The people writing wxWidgets (previously named wxWindows) - without you, this
1306
without you, this also would not have been possible.  You have made the most
1298
also would not have been possible.  You have made the most self-consistent GUI
1307
self-consistent GUI libraries that I have ever used, made them easy to use,
1299
libraries that I have ever used, made them easy to use, and offer them on
1308
and offer them on every platform that I would ever want or need.  You rock.
1300
every platform that I would ever want or need.  You rock.
1309
1301
1310
Neil Hodgson and others who work on Scintilla.  As wx.StyledTextCtrl is a
1302
Neil Hodgson and others who work on Scintilla.  As wx.StyledTextCtrl is a
1311
binding for scintilla in wxWidgets, which then has bindings for wxPython,
1303
binding for scintilla in wxWidgets, which then has bindings for wxPython,
1312
basically ALL the REAL functionality of the editor you are now using is the
1304
basically ALL the REAL functionality of the editor you are now using is the
1313
result of Scintilla.  The additional things like tabbed editing, hotkeys,
1305
result of Scintilla.  The additional things like tabbed editing, hotkeys,