docs/README.rst

branch
setup.py
changeset 6958
949c3c76cc8a
parent 6942
2602857055c5
child 7037
4560e7a43588
equal deleted inserted replaced
6957:59927f5be64e 6958:949c3c76cc8a
1 ======================== 1 ========================
2 README for the eric6 IDE 2 README for the eric6 IDE
3 ======================== 3 ========================
4 4
5 0. What is eric6?
6 -----------------
7 eric6 is a full featured Python editor and IDE, written in Python. It is based
8 on the cross platform Qt UI toolkit, integrating the highly flexible Scintilla
9 editor control. It is designed to be usable as everdays' quick and dirty editor
10 as well as being usable as a professional project management tool integrating
11 many advanced features Python offers the professional coder. eric6 includes a
12 plug-in system, which allows easy extension of the IDE functionality with
13 plug-ins downloadable from the net. For more details see
14 <https://eric-ide.python-projects.org>.
15
5 1. Installation 16 1. Installation
6 --------------- 17 ---------------
7 Installing eric6 is a simple process. Just execute the ``install.py`` script 18 Installing eric6 is a simple process. There are various methods available.
8 (type ``python install.py -h`` for some help). Please note that the 19 Please choose the one best suited to your needs and skills. eric6 may be used
9 installation has to be performed using the administrators account (i.e. root 20 with any combination of Python 3 or 2, Qt5 or Qt4 and PyQt5 or PyQt4. However,
10 on linux). This installs a wrapper script called eric6 in the standard 21 the recommended combination is **Python3** and **PyQt5**.
11 executable directory. 22
23 1.1 Create a Python virtual environment for eric6
24 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 It is recommended to install eric6 into a Python virtual environment in order
26 to keep your Python distribution clean. In order to do that create it by
27 entering the following command in a terminal window::
28
29 python3 -m venv eric6_venv
30
31 Replace ``eric6_venv`` with the desired path to the directory for the virtual
32 environment. All further instructions will assume this environment name.
33
34 1.2a Variant 1: Installation via the "install.py" script
35 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 This method results in the most complete install on all supported platforms.
37 After extracting the eric6 distribution archive just execute the following
38 command in a terminal window::
39
40 ~/eric6_venv/bin/python3 install.py
41
42 Change the path to the Python executable appropriately. The installation script
43 will check for all pre-requisites and will ask for confirmation to install
44 them. If the installation process needs tuning type
45 ``~/eric6_venv/bin/python3 install.py --help`` for some help.
12 46
13 If you want to uninstall the package just execute the ``uninstall.py`` script. 47 If you want to uninstall the package just execute the ``uninstall.py`` script.
14 This gets rid of all installed files. In this case please send an email to the 48 This gets rid of all installed files. In this case please send an email to the
15 below mentioned address and tell me your reason. This might give me a hint on 49 below mentioned address and tell me your reason. This might give me a hint on
16 how to improve eric6. 50 how to improve eric6.
17 51
18 eric6 may be used with any combination of Python 3 or 2, Qt5 or Qt4 and 52 1.2b Variant 2: Installation via the Python Package Index PyPI
19 PyQt5 or PyQt4. If the required packages (Qt5/4, QScintilla2, sip and PyQt5/4) 53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 are not installed, please get them and install them in the following order 54 This method is the easiest one but does not create a macOS® Application. Enter
21 (order is important). 55 the following command in a terminal window::
22 56
23 1. Install Qt5 (from The Qt Company) 57 ~/eric6_venv/bin/python3 -m pip install eric6
24 58
25 2. Build and install QScintilla2 (from Riverbank Computing) 59 Once the installation is finished navigate to the executable directory of
26 60 the Python virtual environment and execute the ``eric6_post_install`` script.
27 3. Build and install sip (from Riverbank Computing) 61 This will create application menu entries on Linux and desktop and start menu
28 62 entries on Windows® platforms.
29 4. Build and install PyQt5 (from Riverbank Computing) 63
30 64 1.3 Installation of Qt Tools via Qt online installer
31 5. Build and install QScintilla2 Python bindings 65 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32 (part of the QScintilla2 package) 66 In order to get the most out of eric6 it is recommended to install the Qt Tools
33 67 like ``Qt Designer`` or ``Qt Linguist``. The recommended way is this.
34 6. Install eric6 68
35
36 If you want to use the interfaces to other supported software packages, you may
37 install them in any order and at any time.
38
39 Please note, that the QScintilla2 Python bindings have to be rebuild, if
40 the PyQt5 package gets updated. If this step is omitted, a bunch of strange
41 errors will occur.
42
43 1.1 Installation on Windows®
44 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45 **Note:** This section is valid for PyQt4 and PyQt5 before 5.7.0.
46
47 Installing eric6 on Windows® is even easier. Just download the PyQt5
48 installer from Riverbank Computing and use it to install PyQt5. This includes
49 all the required Qt5 libraries and tools as well as QScintilla. Once
50 this installation is completed install eric6. That's all.
51
52 1.2 Installation using PyQt5 wheels
53 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54 **Note:** This section is valid for PyQt5 5.7.0 or newer.
55
56 Installing eric6 and its pre-requisites is even easier using the PyQt5 Python
57 wheels. In order to have access to the suite of Qt tools and documentation it
58 is recommended to install the Qt development environment. These tools are not
59 part of the PyQt5 wheels. Users of the Windows® operating system may use the
60 'pyqt5-tools' wheel available via the Python Package Index (PyPI) as of
61 2017-05-12.
62
63 1.2.1 Installation of Qt Tools via Qt online installer
64 ======================================================
65 1. Download the Qt online installer from the Qt download site. 69 1. Download the Qt online installer from the Qt download site.
66 70
67 2. Install Qt by executing the installer. 71 2. Install Qt by executing the installer.
68 72
69 1.2.2 Installation of Qt Tools via PyPI 73 3. Configure the path to the Qt tools on the ``Qt`` configuration page of the
70 ======================================= 74 eric6 configuration dialog.
71 1. Install the Qt tools by entering this command in a command window::
72
73 pip install pyqt5-tools
74
75 1.2.3 Installation of PyQt5 and eric
76 ====================================
77 1. Install the eric6 pre-requisites (PyQt, sip and QScintilla) by entering
78 this command in a shell / command window::
79
80 pip install qscintilla
81
82 or ::
83
84 pip3 install qscintilla
85
86 This will install QScintilla and all dependencies, which are PyQt5 and sip.
87
88 2. Install eric6 and configure the path to the Qt tools on the Qt page of the
89 configuration dialog.
90
91 3. Once the eric6 IDE is started the Qt documentation may be loaded into the
92 eric web browser via the ``Settings ➡ Mange Qt Help Documents`` menu entry.
93 75
94 2. Installation of translations 76 2. Installation of translations
95 ------------------------------- 77 -------------------------------
96 Translations of the eric6 IDE are available as separate downloads. There 78 The default distribution archive of eric6 includes all supported translations
97 are two ways to install them. 79 already. If the above installation variant 1 was performed with this, you may
98 80 skip this section.
99 The first possibility is to install them together with eric6. In order 81
100 to do that, simply extract the downloaded archives into the same place 82 If the ``nolang`` archive was used, translations may be added later on by
101 as the eric6 archive and follow the installation instructions above. 83 downloading the desired language pack, extract it to a temporary directory
102 84 and execute the install-i18n.py script (type
103 The second possibility is to install them separately. Extract the 85 ``~/eric6_venv/bin/python3 install-i18n.py``).
104 downloaded archives and execute the install-i18n.py script (type
105 ``python install-i18n.py -h`` for some help). This way you can make the
106 translations available to everybody or just to the user executing the
107 installation command (if using the -p switch).
108 86
109 3. Running 87 3. Running
110 ---------- 88 ----------
111 Just call up eric6, which will start the IDE. Use the "what is"-help 89 Just call up eric6, which will start the IDE. Use the "what is"-help
112 (arrow with ?) to get some help. The eric web site provides some 90 (arrow with ?) to get some help. The eric web site provides some
113 documents describing certain aspects of eric. To start the unit test module in 91 documents describing certain aspects of eric. To start the unit test module in
114 a standalone variant simply call up eric6_unittest. This will show the same 92 a standalone variant simply call up eric6_unittest. This will show the same
115 dialog (though with a little bit less functionality) as if started from within 93 dialog (though with a little bit less functionality) as if started from within
116 eric6. The web browser can be started as a standalone program by executing the 94 eric6. The web browser can be started as a standalone program by executing the
117 eric6_webbrowser script. 95 eric6_browser script.
118 96
119 Please note, the first time you start eric6 it will recognize, that it 97 Please note, the first time you start eric6 it will recognize, that it
120 hasn't been configured yet and will show the configuration dialog. 98 hasn't been configured yet, and will show the configuration dialog.
121 Please take your time and go through all the configuration items. 99 Please take your time and go through all the configuration items.
122 However, every configuration option has a meaningful default value. 100 However, every configuration option has a meaningful default value.
123 101
124 4. Running from the sources 102 4. Running from the sources
125 --------------------------- 103 ---------------------------
132 --------------- 110 ---------------
133 eric6 comes with a little utility called "eric6_tray". This embeds an icon 111 eric6 comes with a little utility called "eric6_tray". This embeds an icon
134 in the system tray, which contains a context menu to start eric6 and all 112 in the system tray, which contains a context menu to start eric6 and all
135 it's utilities. Double clicking this icon starts the eric6 IDE. 113 it's utilities. Double clicking this icon starts the eric6 IDE.
136 114
137 6. Autocompletion/Calltips 115 6. Completions/Calltips
138 -------------------------- 116 -----------------------
139 eric6 provides an interface to the QScintilla auto-completion and calltips 117 eric6 provides an interface to the QScintilla completion and calltips
140 functionality. QScintilla2 comes with API files for Python and itself. PyQt4 118 functionality. QScintilla2 comes with API files for Python and itself. PyQt4
141 and PyQt5 contain API files as well. These are installed by default, if the 119 and PyQt5 contain API files as well. These are installed by default. An API
142 correct installation order (see above) is followed. An API file for eric6 is 120 file for eric6 is installed in the same place, if installation variant 1 was
143 installed in the same place. 121 chosen.
144 122
145 In order to use autocompletion and calltips in eric6 please configure these 123 In order to use completions and calltips in eric6 please configure these
146 functions in the "Preferences Dialog" on the "Editor -> APIs", 124 functions in the "Preferences Dialog" on the "Editor -> APIs",
147 "Editor -> Autocompletion" and "Editor -> Calltips" pages. 125 "Editor -> Autocompletion" and "Editor -> Calltips" pages.
126
127 Additional completions and calltip providers are available through the eric6
128 plug-in system. See below for details.
148 129
149 7. Remote Debugger 130 7. Remote Debugger
150 ------------------ 131 ------------------
151 In order to enable the remote debugger start eric6, open the preferences 132 In order to enable the remote debugger start eric6, open the preferences
152 dialog and configure the settings on the debugger pages. 133 dialog and configure the settings on the debugger pages.
193 This is part of the Qt distribution and may be used to display help 174 This is part of the Qt distribution and may be used to display help
194 files. 175 files.
195 176
196 Mercurial 177 Mercurial
197 This is a distributed version control system available from 178 This is a distributed version control system available from
198 <http://www.mercurial-scm.org>. It is the one used by eric6 itself. 179 <https://www.mercurial-scm.org/>. It is the one used by eric6 itself.
180
181 Git
182 This is another (and probably more widely known) distributed version
183 control system. It is available from <https://www.git-scm.com>.
199 184
200 Subversion 185 Subversion
201 This is a version control system available from 186 This is a version control system available from
202 <http://subversion.apache.org>. eric6 supports two different Subversion 187 <https://subversion.apache.org>. eric6 supports two different
203 interfaces. One is using the svn command line tool, the other is using 188 Subversion interfaces. One is using the svn command line tool, the
204 the PySvn Python interface <pysvn.tigris.org>. The selection is done 189 other is using the PySvn Python interface
205 automatically depending on the installed software. The PySvn interface 190 <https://pysvn.sourceforge.io/>. The selection is done automatically
206 is prefered. This automatism can be overridden an a per project basis 191 depending on the installed software. The PySvn interface is preferred.
207 using the "User Properties" dialog. 192 This automatism can be overridden an a per project basis using the
193 "User Properties" dialog.
208 194
209 coverage.py 195 coverage.py
210 This is a tool to check Python code coverage. A slightly modified 196 This is a tool to check Python code coverage. A slightly modified
211 version is part of the eric6 distribution. The original version is 197 version is part of the eric6 distribution. The original version is
212 available from <http://www.nedbatchelder.com/code/modules/coverage.html> 198 available from
213 199 <http://www.nedbatchelder.com/code/modules/coverage.html>
214 tabnanny
215 This is a tool to check Python code for white-space related problems.
216 It is part of the standard Python installation.
217 200
218 profile 201 profile
219 This is part of the standard Python distribution and is used to profile 202 This is part of the standard Python distribution and is used to profile
220 Python source code. 203 Python source code.
221 204
241 usable via the commandline as well. For further details please see 224 usable via the commandline as well. For further details please see
242 the file README-eric6-doc.rst. 225 the file README-eric6-doc.rst.
243 226
244 14. License 227 14. License
245 ----------- 228 -----------
246 eric6 (and the others) is released under the conditions of the GPL. See 229 eric6 (and the others) is released under the conditions of the GPLv3. See
247 separate license file for more details. Third party software included in 230 separate license file ``LICENSE.GPL3`` for more details. Third party software
248 eric6 is released under their respective license and contained in the 231 included in eric6 is released under their respective license and contained in
249 eric6 distribution for convenience. 232 the eric6 distribution for convenience.
250 233
251 15. Bugs and other reports 234 15. Bugs and other reports
252 -------------------------- 235 --------------------------
253 Please send bug reports, feature requests or contributions to eric bugs 236 Please send bug reports, feature requests or contributions to eric bugs
254 address. After the IDE is installed you can use the "Report Bug..." 237 address. After the IDE is installed you can use the "Report Bug..."

eric ide

mercurial