| 1 | $prog $version |
|---|
| 2 | $release_date |
|---|
| 3 | Copyright (c) $yearrange $author ($author_email) |
|---|
| 4 | |
|---|
| 5 | $url |
|---|
| 6 | |
|---|
| 7 | |
|---|
| 8 | |
|---|
| 9 | ABSTRACT |
|---|
| 10 | ======== |
|---|
| 11 | |
|---|
| 12 | $prog - $description |
|---|
| 13 | |
|---|
| 14 | This is a wxPython/Scintilla-based editor and framework written in and |
|---|
| 15 | extensible through Python. It attempts to provide an XEmacs-like multi- |
|---|
| 16 | window, multi-tabbed interface. The architectural goal is to provide a system |
|---|
| 17 | with low coupling in order to reduce the work required to extend the editor |
|---|
| 18 | with new major modes, minor modes, and sidebars. |
|---|
| 19 | |
|---|
| 20 | |
|---|
| 21 | |
|---|
| 22 | FEATURES |
|---|
| 23 | ======== |
|---|
| 24 | |
|---|
| 25 | * XEmacs feel |
|---|
| 26 | |
|---|
| 27 | * Multiple top-level windows |
|---|
| 28 | |
|---|
| 29 | * AUI widgets for an awesomely awesome, cutting-edge GUI |
|---|
| 30 | |
|---|
| 31 | * Interesting major modes like: |
|---|
| 32 | |
|---|
| 33 | * MPDMode for controlling a Music Player Daemon instance. Point it |
|---|
| 34 | to a music player daemon instance using the url mpd://host[:port] |
|---|
| 35 | where the port will default to 6600 if you don't specify it. |
|---|
| 36 | |
|---|
| 37 | * HSIMode for viewing hyperspectral image files |
|---|
| 38 | |
|---|
| 39 | * AptusMode for viewing the Mandelbrot fractal using Ned Batchelder's Aptus |
|---|
| 40 | (requires numpy). |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | Many more features are available or planned. See the roadmap on the web at |
|---|
| 44 | http://trac.flipturn.org/roadmap |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | |
|---|
| 48 | DOCUMENTATION |
|---|
| 49 | ============= |
|---|
| 50 | |
|---|
| 51 | Currently a bit lacking. See the web at: |
|---|
| 52 | |
|---|
| 53 | $url |
|---|
| 54 | |
|---|
| 55 | for what's available. |
|---|
| 56 | |
|---|
| 57 | |
|---|
| 58 | |
|---|
| 59 | PREREQUISITES |
|---|
| 60 | ============= |
|---|
| 61 | |
|---|
| 62 | python 2.4 or later |
|---|
| 63 | wxPython 2.8 or later |
|---|
| 64 | |
|---|
| 65 | Currently developed on Python 2.5.1 and wxPython 2.8.4.0 on Linux, and Python |
|---|
| 66 | 2.5 and wxPython 2.8.6.0 on Windows. |
|---|
| 67 | |
|---|
| 68 | Peppy requires such a new version of wxPython because it's using the AUI |
|---|
| 69 | (Advanced User Interface) set of widgets for the main frame and the notebook. |
|---|
| 70 | |
|---|
| 71 | |
|---|
| 72 | Optional: pyenchant |
|---|
| 73 | ------------------- |
|---|
| 74 | |
|---|
| 75 | Peppy will automatically spell check documents on the fly if the pyenchant |
|---|
| 76 | module is installed. Get it from |
|---|
| 77 | |
|---|
| 78 | http://pyenchant.sourceforge.net |
|---|
| 79 | |
|---|
| 80 | I've tested with 1.3.1, but should work with 1.2.0 and later. |
|---|
| 81 | |
|---|
| 82 | |
|---|
| 83 | Optional: numpy |
|---|
| 84 | --------------- |
|---|
| 85 | |
|---|
| 86 | The Aptus plugin and the optional hyperspectral image view mode require: |
|---|
| 87 | |
|---|
| 88 | numpy 1.0 or later |
|---|
| 89 | |
|---|
| 90 | The hyperspectral image view mode will have additional functionality and |
|---|
| 91 | provide support for more types of images if it finds: |
|---|
| 92 | |
|---|
| 93 | scipy 0.5.2 or later |
|---|
| 94 | gdal 1.4.0 or later |
|---|
| 95 | |
|---|
| 96 | Without GDAL support, only raw image formats like ENVI are available. GDAL |
|---|
| 97 | provides image loading capability for a wide variety of formats, including |
|---|
| 98 | compressed images. To use GDAL support, the ngpython swig bindings must be |
|---|
| 99 | used when compiling the module. See the file INSTALL for more information. |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | RUNNING THE PROGRAM |
|---|
| 104 | =================== |
|---|
| 105 | |
|---|
| 106 | This is still alpha software, so caveat emptor. I recommend just running it |
|---|
| 107 | out of the directory in which the software was unpacked. |
|---|
| 108 | |
|---|
| 109 | $ tar xfv peppy-$version.tar.bz2 |
|---|
| 110 | $ cd peppy-$version |
|---|
| 111 | $ python peppy.py |
|---|
| 112 | |
|---|
| 113 | |
|---|
| 114 | |
|---|
| 115 | RUNNING THE UNIT TESTS |
|---|
| 116 | ====================== |
|---|
| 117 | |
|---|
| 118 | peppy uses the nose testing framework, available here: |
|---|
| 119 | |
|---|
| 120 | http://somethingaboutorange.com/mrl/projects/nose/ |
|---|
| 121 | |
|---|
| 122 | or if you have setuptools installed, using |
|---|
| 123 | |
|---|
| 124 | $ easy_install nose |
|---|
| 125 | |
|---|
| 126 | Once you have nose installed, you can run all the unit tests by |
|---|
| 127 | running |
|---|
| 128 | |
|---|
| 129 | $ noserun.sh |
|---|
| 130 | |
|---|
| 131 | in the tests/ directory. |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | |
|---|
| 135 | KNOWN ISSUES |
|---|
| 136 | ============ |
|---|
| 137 | |
|---|
| 138 | This editor is still in heavy development, but I am using it as my primary |
|---|
| 139 | editor and have felt that it is stable enough that it has replaced XEmacs in |
|---|
| 140 | my daily life. |
|---|
| 141 | |
|---|
| 142 | The only time 0.7.* has ever crashed was due to an obscure AUI bug that I |
|---|
| 143 | have not been able to track down. It was caused by splitting the notebook |
|---|
| 144 | by dragging a tab to form a new notebook, then dragging the tab back to the |
|---|
| 145 | original notebook. I've not been able to duplicate it, but if you experiment |
|---|
| 146 | with the AUI tab dragging feature, I'd suggest saving your work before trying |
|---|
| 147 | it. |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | CREDITS |
|---|
| 152 | ======= |
|---|
| 153 | |
|---|
| 154 | See the the web at $url/thanks.html |
|---|
| 155 | for a complete list of contributors. |
|---|
| 156 | |
|---|
| 157 | |
|---|
| 158 | |
|---|
| 159 | DISCLAIMER |
|---|
| 160 | ========== |
|---|
| 161 | |
|---|
| 162 | $prog, $description |
|---|
| 163 | Copyright (c) $yearrange $author ($author_email) |
|---|
| 164 | |
|---|
| 165 | This program is free software; you can redistribute it and/or modify |
|---|
| 166 | it under the terms of the GNU General Public License as published by |
|---|
| 167 | the Free Software Foundation; either version 2 of the License, or |
|---|
| 168 | (at your option) any later version. |
|---|
| 169 | |
|---|
| 170 | This program is distributed in the hope that it will be useful, |
|---|
| 171 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
|---|
| 172 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|---|
| 173 | GNU General Public License for more details. |
|---|
| 174 | |
|---|
| 175 | You should have received a copy of the GNU General Public License along |
|---|
| 176 | with this program; if not, write to the Free Software Foundation, Inc., |
|---|
| 177 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
|---|
