README

Fri, 11 Mar 2011 16:51:57 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 11 Mar 2011 16:51:57 +0100
changeset 945
8cd4d08fa9f6
parent 100
55c6a9109dfa
child 1225
254ec677c775
permissions
-rw-r--r--

Made code mostly PEP 8 compliant (except all whitespace and line length).

59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
1 README for the eric5 IDE
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 Installation
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
5 Installing eric5 is a simple process. Just execute the install.py script
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 (type python install.py -h for some help). Please note that the installation
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 has to be performed using the administrators account (i.e. root on linux).
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 This installs a wrapper script in the standard executable directory
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
9 (default: /usr/local/bin on linux) called eric5.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 If you want to uninstall the package just execute the uninstall script. This
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12 gets rid of all installed files. In this case please send an email to the
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 below mentioned address and tell me your reason. This might give me a hint on
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
14 how to improve eric5.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 If the required packages (Qt4, QScintilla2, sip and PyQt4) are not installed,
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 please get them and install them in the following order (order is important).
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 1. Install Qt4
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 2. Build and install sip
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 3. Build and install QScintilla2
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 4. Build and install PyQt4
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 5. Build and install QScintilla2 Python bindings
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
29 6. Install eric5
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 If you want to use the interfaces to other supported software packages, you may
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 install them in any order and at any time.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 Installation of translations
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
36 Translations of the eric5 IDE are available as separate downloads. There
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 are two ways to install them.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
39 The first possibility is to install them together with eric5. In order
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 to do that, simply extract the downloaded archives into the same place
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
41 as the eric5 archive and follow the installation instructions above.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 The second possibility is to install them separately. Extract the
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 downloaded archives and execute the install-i18n.py script (type
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 python install-i18n.py -h for some help). This way you can make the
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 translations available to everybody or just to the user executing the
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 installation command (if using the -p switch).
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 Running
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
51 Just call up eric5, which will start the IDE. Use the "what is"-help
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 (arrow with ?) to get some help. Sorry, there is no documentation yet.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 To start the unit test module in a standalone variant simply call up
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
54 eric5-unittest. This will show the same dialog (though with a little bit less
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
55 functionality) as if started from within eric5. The helpviewer can be
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
56 started as a standalone program by executing the eric5-webbrowser script.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
58 Please note, the first time you start eric5 it will recognize, that it
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 hasn't been configured yet and will show the configuration dialog.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 Please take your time and go through all the configuration items.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
61 However, every configuration option has a meaningful default value.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
62
100
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
63 Running from the sources
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
64
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
65 If you want to run eric5 from within the source tree you have to execute
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
66 the compileUiFiles.py script once after a fresh checkout from the source
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
67 repository or when new dialogs have been added. Thereafter just execute
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
68 the eric5.py script.
55c6a9109dfa Updated the README file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 59
diff changeset
69
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
70 Tray starter
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
72 eric5 comes with a little utility called "eric5-tray". This embeds an icon
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
73 in the system tray, which contains a context menu to start eric5 and all
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
74 it's utilities. Double clicking this icon starts the eric5 IDE.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 Autocompletion/Calltips
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
78 eric5 provides an interface to the QScintilla auto-completion and calltips
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 functionality. QScintilla2 comes with API files for Python and itself. PyQt4
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 contains an API file as well. These are installed by default, if the correct
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
81 installation order (see above) is followed. An API file for eric5 is
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 installed in the same place.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
84 In order to use autocompletion and calltips in eric5 please configure these
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 functions in the "Preferences Dialog" on the "Editor -> APIs",
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 "Editor -> Autocompletion" and "Editor -> Calltips" pages.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 Remote Debugger
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
90 In order to enable the remote debugger start eric5, open the preferences
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 dialog and configure the settings on the debugger pages.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 The remote login must be possible without any further interaction (i.e.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 no password prompt). If the remote setup differs from the local one you
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
95 must configure the Python interpreter and the Debug Client to be used
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
96 in the Preferences dialog. eric5 includes two different versions of the
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
97 debug client. DebugClient.py is the traditional debugger and
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
98 DebugClientThreads is a multithreading variant of the debug client.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
99 Please copy all needed files to a place accessible through the Python path
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
100 of the remote machine and set the entries of the a.m. configuration tab
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
101 accordingly.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
102
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
103 Passive Debugging
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
104
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
105 Passive debugging mode allows the startup of the debugger from outside
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
106 of the IDE. The IDE waits for a connection attempt. For further details
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
107 see the file README-passive-debugging.txt
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
108
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
109 Plugin System
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
110
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
111 eric5 contains a plugin system, that is used to extend eric5's
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
112 functionality. Some plugins are part of eric5. Additional plugins
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
113 are available via the Internet. Please use the built in plug-in
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
114 repository dialog to get a list of available (official) plugins
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
115 and to download them. For more details about the plug-in system
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
116 please see the documentation area.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
117
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
118 Interfaces to additional software packages
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
119
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
120 At the moment eric5 provides interfaces to the following software
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
121 packages.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
122
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
123 Qt-Designer
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
124 This is part of the Qt distribution and is used to generate user
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
125 interfaces.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
126
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
127 Qt-Linguist
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
128 This is part of the Qt distribution and is used to generate translations.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
129
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
130 Qt-Assistant
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
131 This is part of the Qt distribution and may be used to display help files.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
132
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
133 Subversion
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
134 This is another version control system available from
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
135 <subversion.tigris.org>. It is meant to be the successor of CVS.
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
136 eric5 supports two different Subversion interfaces. One is using
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
137 the svn command line tool, the other is using the PySvn Python
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
138 interface <pysvn.tigris.org>. The selection is done automatically
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
139 depending on the installed software. The PySvn interface is prefered.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
140 This automatism can be overridden an a per project basis using
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
141 the "User Properties" dialog.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
142
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
143 coverage.py
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
144 This is a tool to check Python code coverage. A slightly modified
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
145 version is part of the eric5 distribution. The original version is
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
146 available from <www.nedbatchelder.com/code/modules/coverage.html>
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
147
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
148 tabnanny
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
149 This is a tool to check Python code for white-space related problems. It
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
150 is part of the standard Python installation.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
151
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
152 profile
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
153 This is part of the standard Python distribution and is used to profile
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
154 Python source code.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
155
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
156 cyclops
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
157 This is a tool to detect variable cycles which can cause the garbage
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
158 collector being unable to do his job.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
159
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
160 Interfaces to additional software packages via plugins
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
161
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
162 Some of the interfaces provided as plugins are as follows.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
163
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
164 CVS
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
165 This is a version control system available from <www.cvshome.org>.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
166
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167 pylint
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
168 This is a tool to check the source code according to various rules.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
169 It is available from <http://www.logilab.org/projects/pylint>.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
170
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
171 cx_Freeze
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
172 This is a tool for packaging Python programs. It is available from
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
173 <http://starship.python.net/crew/atuining/cx_Freeze>
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
174
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
175 Internationalization
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
176
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
177 eric5 and it's tools are prepared to show the UI in different
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
178 languages, which can be configured via the preferences dialog. The Qt and
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
179 QScintilla translations are searched in the translations directory given
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
180 in the preferences dialog (Qt page). If the translations cannot be found,
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
181 some part of the MMI might show English texts even if you have selected
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
182 something else. If you are missing eric5 translations for your language
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
183 and are willing to volunteer for this work please send me an email naming
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
184 the country code and I will send you the respective Qt-Linguist file.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
185
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
186 Window Layout
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
187
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
188 eric5 provides different window layouts. In these layouts, the shell window
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
189 and the file browser may be embedded or be separat windows.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
190
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
191 Source code documentation
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
192
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
193 eric5 has a built in source code documentation generator, which is
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
194 usable via the commandline as well. For further details please see
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
195 the file README-eric5-doc.txt
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
196
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
197 License
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
198
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
199 eric5 (and the others) is released under the conditions of the GPL. See
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
200 separate license file for more details. Third party software included in
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
201 eric5 is released under their respective license and contained in the
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
202 eric5 distribution for convenience.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
203
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
204 Bugs and other reports
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
205
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
206 Please send bug reports, feature requests or contributions to eric bugs address.
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
207 After the IDE is installed you can use the "Report Bug..." entry of the Help menu.
59
6f891dcc93d9 Changed eric4 to read eric5.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 0
diff changeset
208 This will send a message to <eric5-bugs@die-offenbachs.de>

eric ide

mercurial