docs/README.rst

Sat, 02 May 2020 14:04:18 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 02 May 2020 14:04:18 +0200
changeset 7562
0f25563f8ff4
parent 7222
fc6530b432ad
child 7929
fdd769e06482
permissions
-rw-r--r--

setup.py: corrected the links to the source code repository and the issues tracker.

4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
1 ========================
3682
2543741b47b7 Changed a few files to reference eric6.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1225
diff changeset
2 README for the eric6 IDE
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
3 ========================
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
4
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
5 0. What is eric6?
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
6 -----------------
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
7 eric6 is a full featured Python editor and IDE, written in Python. It is based
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
8 on the cross platform Qt UI toolkit, integrating the highly flexible Scintilla
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
9 editor control. It is designed to be usable as everdays' quick and dirty editor
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
10 as well as being usable as a professional project management tool integrating
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
11 many advanced features Python offers the professional coder. eric6 includes a
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
12 plug-in system, which allows easy extension of the IDE functionality with
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
13 plug-ins downloadable from the net. For more details see
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
14 <https://eric-ide.python-projects.org>.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
15
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
16 1. Installation
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
17 ---------------
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
18 Installing eric6 is a simple process. There are various methods available.
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
19 Please choose the one best suited to your needs and skills. eric6 may be must
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
20 with Python 3, Qt5 and PyQt5.
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
21
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
22 1.1 Create a Python virtual environment for eric6
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
23 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
24 It is recommended to install eric6 into a Python virtual environment in order
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
25 to keep your Python distribution clean. In order to do that create it by
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
26 entering the following command in a terminal window::
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
27
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
28 python3 -m venv eric6_venv
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
29
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
30 Replace ``eric6_venv`` with the desired path to the directory for the virtual
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
31 environment. All further instructions will assume this environment name.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
32
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
33 1.2a Variant 1: Installation via the "install.py" script
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
34 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
35 This method results in the most complete install on all supported platforms.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
36 After extracting the eric6 distribution archive just execute the following
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
37 command in a terminal window::
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
38
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
39 ~/eric6_venv/bin/python3 install.py
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
40
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
41 Change the path to the Python executable appropriately. The installation script
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
42 will check for all pre-requisites and will ask for confirmation to install
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
43 them. If the installation process needs tuning type
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
44 ``~/eric6_venv/bin/python3 install.py --help`` for some help.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
45
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
46 If you want to uninstall the package just execute the ``uninstall.py`` script.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
47 This gets rid of all installed files. In this case please send an email to the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
48 below mentioned address and tell me your reason. This might give me a hint on
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
49 how to improve eric6.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
50
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
51 1.2b Variant 2: Installation via the Python Package Index PyPI
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
52 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
53 This method is the easiest one but does not create a macOS® Application. Enter
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
54 the following command in a terminal window::
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
55
7037
4560e7a43588 README.rst: Fixed some issues in the text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6958
diff changeset
56 ~/eric6_venv/bin/python3 -m pip install --upgrade eric-ide
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
57
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
58 Once the installation is finished navigate to the executable directory of
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
59 the Python virtual environment and execute the ``eric6_post_install`` script.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
60 This will create application menu entries on Linux and desktop and start menu
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
61 entries on Windows® platforms.
4313
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
62
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
63 1.3 Installation of Qt Tools via Qt online installer
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
64 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
65 In order to get the most out of eric6 it is recommended to install the Qt Tools
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
66 like ``Qt Designer`` or ``Qt Linguist``. The recommended way is this.
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
67
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
68 1. Download the Qt online installer from the Qt download site.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
69
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
70 2. Install Qt by executing the installer.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
71
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
72 3. Configure the path to the Qt tools on the ``Qt`` configuration page of the
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
73 eric6 configuration dialog.
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
74
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
75 2. Installation of translations
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
76 -------------------------------
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
77 The default distribution archive of eric6 includes all supported translations
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
78 already. If the above installation variant 1 was performed with this, you may
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
79 skip this section.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
80
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
81 If the ``nolang`` archive was used, translations may be added later on by
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
82 downloading the desired language pack, extract it to a temporary directory
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
83 and execute the install-i18n.py script (type
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
84 ``~/eric6_venv/bin/python3 install-i18n.py``).
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
85
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
86 3. Running
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
87 ----------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
88 Just call up eric6, which will start the IDE. Use the "what is"-help
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
89 (arrow with ?) to get some help. The eric web site provides some
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
90 documents describing certain aspects of eric. To start the unit test module in
4313
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
91 a standalone variant simply call up eric6_unittest. This will show the same
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
92 dialog (though with a little bit less functionality) as if started from within
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
93 eric6. The web browser can be started as a standalone program by executing the
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
94 eric6_browser script.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
95
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
96 Please note, the first time you start eric6 it will recognize, that it
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
97 hasn't been configured yet, and will show the configuration dialog.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
98 Please take your time and go through all the configuration items.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
99 However, every configuration option has a meaningful default value.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
100
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
101 4. Running from the sources
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
102 ---------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
103 If you want to run eric6 from within the source tree you have to execute
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
104 the ``compileUiFiles.py`` script once after a fresh checkout from the source
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
105 repository or when new dialogs have been added. Thereafter just execute
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
106 the ``eric6.py`` script.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
107
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
108 5. Tray starter
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
109 ---------------
4313
4dc78bc82783 Updated the README to include a section about installation on Windows using the PyQt installer.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4266
diff changeset
110 eric6 comes with a little utility called "eric6_tray". This embeds an icon
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
111 in the system tray, which contains a context menu to start eric6 and all
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
112 it's utilities. Double clicking this icon starts the eric6 IDE.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
113
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
114 6. Completions/Calltips
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
115 -----------------------
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
116 eric6 provides an interface to the QScintilla completion and calltips
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
117 functionality. QScintilla2 comes with API files for Python and itself. PyQt4
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
118 and PyQt5 contain API files as well. These are installed by default. An API
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
119 file for eric6 is installed in the same place, if installation variant 1 was
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
120 chosen.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
121
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
122 In order to use completions and calltips in eric6 please configure these
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
123 functions in the "Preferences Dialog" on the "Editor -> APIs",
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
124 "Editor -> Autocompletion" and "Editor -> Calltips" pages.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
125
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
126 Additional completions and calltip providers are available through the eric6
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
127 plug-in system. See below for details.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
128
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
129 7. Remote Debugger
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
130 ------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
131 In order to enable the remote debugger start eric6, open the preferences
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
132 dialog and configure the settings on the debugger pages.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
133
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
134 The remote login must be possible without any further interaction (i.e.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
135 no password prompt). If the remote setup differs from the local one you
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
136 must configure the Python interpreter and the Debug Client to be used
5422
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5403
diff changeset
137 in the Preferences dialog. Use the ``install-debugclients.py`` script
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5403
diff changeset
138 to install the debug client files and set the entries of the a.m.
222da86472d9 Some corrections to readme files and debugger stuff, which still referenced the old standard/threaded debugger variants.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5403
diff changeset
139 configuration page accordingly.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
140
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
141 To ease the installation process of the debug client, the eric6 sources
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
142 include the script ``install-debugclients.py``.
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
143
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
144 8. Passive Debugging
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
145 --------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
146 Passive debugging mode allows the startup of the debugger from outside
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
147 of the IDE. The IDE waits for a connection attempt. For further details
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
148 see the file README-passive-debugging.rst.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
149
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
150 9. Plug-in System
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
151 -----------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
152 eric6 contains a plug-in system, that is used to extend eric6's
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
153 functionality. Some plug-ins are part of eric6. Additional plugins
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
154 are available via the Internet. Please use the built-in plug-in
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
155 repository dialog to get a list of available (official) plug-ins
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
156 and to download them. For more details about the plug-in system
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
157 please see the documentation area.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
158
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
159 10. Interfaces to additional software packages
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
160 ----------------------------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
161 At the moment eric6 provides interfaces to the following software
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
162 packages.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
163
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
164 Qt-Designer
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
165 This is part of the Qt distribution and is used to generate user
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
166 interfaces.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
167
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
168 Qt-Linguist
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
169 This is part of the Qt distribution and is used to generate
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
170 translations.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
171
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
172 Qt-Assistant
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
173 This is part of the Qt distribution and may be used to display help
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
174 files.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
175
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
176 Mercurial
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
177 This is a distributed version control system available from
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
178 <https://www.mercurial-scm.org/>. It is the one used by eric6 itself.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
179
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
180 Git
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
181 This is another (and probably more widely known) distributed version
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
182 control system. It is available from <https://www.git-scm.com>.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
183
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
184 Subversion
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
185 This is a version control system available from
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
186 <https://subversion.apache.org>. eric6 supports two different
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
187 Subversion interfaces. One is using the svn command line tool, the
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
188 other is using the PySvn Python interface
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
189 <https://pysvn.sourceforge.io/>. The selection is done automatically
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
190 depending on the installed software. The PySvn interface is preferred.
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
191 This automatism can be overridden an a per project basis using the
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
192 "User Properties" dialog.
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
193
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
194 coverage.py
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
195 This is a tool to check Python code coverage. A slightly modified
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
196 version is part of the eric6 distribution. The original version is
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
197 available from
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
198 <http://www.nedbatchelder.com/code/modules/coverage.html>
0
de9c2efb9d02 Started porting eric4 to Python3
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
199
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
200 profile
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
201 This is part of the standard Python distribution and is used to profile
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
202 Python source code.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
203
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
204 11. Internationalization
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
205 ------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
206 eric6 and its tools are prepared to show the UI in different languages, which
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
207 can be configured via the preferences dialog. The Qt and QScintilla
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
208 translations are searched in the translations directory given in the
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
209 preferences dialog (Qt page). If the translations cannot be found, some part
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
210 of the MMI might show English texts even if you have selected something else.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
211 If you are missing eric6 translations for your language and are willing to
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
212 volunteer for this work please send me an email naming the country code and
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
213 I will send you the respective Qt-Linguist file.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
214
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
215 12. Window Layout
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
216 -----------------
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
217 eric6 provides a configurable window layout. The visibility of the various tool
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
218 panes can be configured. The position of the shell pane may be configured as
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
219 well.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
220
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
221 13. Source code documentation
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
222 -----------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
223 eric6 has a built in source code documentation generator, which is
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
224 usable via the commandline as well. For further details please see
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
225 the file README-eric6-doc.rst.
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
226
7222
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
227 14. Included Tools
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
228 ------------------
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
229 eric6 comes with a long list of tools. These can be started via the eric6
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
230 tray starter or directly via the commandline. They are available from within
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
231 the IDE. The included tools are (sorted alphabetically):
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
232
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
233 * **eric6_api.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
234
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
235 This is the tool to generate API files from Python source code.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
236
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
237 * **eric6_browser.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
238
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
239 This is the eric6 web browser. It is a full blown browser based on
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
240 QtWebEngine, which is based on the Chromium web engine.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
241
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
242 * **eric6_compare.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
243
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
244 This tool may be used to compare two files side-by-side. Differences
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
245 between the files are highlighted by coloring the text.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
246
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
247 * **eric6_configure.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
248
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
249 This is the standalone variant of the configuration dialog. It offers
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
250 most of the configuration options as are available from within eric6.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
251
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
252 * **eric6_diff.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
253
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
254 This tool may be used to view the differences between two files. These
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
255 are shown as a unified or context diff.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
256
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
257 * **eric6_doc.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
258
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
259 This is the tool to extract source code documentation from source files
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
260 and format that as HTML files.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
261
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
262 * **eric6_editor.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
263
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
264 This is a stripped down, standalone variant of the editor embedded in the
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
265 eric6 IDE.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
266
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
267 * **eric6_hexeditor.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
268
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
269 This is a standalone hex editor to work with binary files.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
270
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
271 * **eric6_iconeditor.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
272
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
273 This is a little tool to create pixel based icons and save them in a
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
274 pixmap format.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
275
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
276 * **eric6_plugininstall.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
277
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
278 This is a standalone utility to install eric6 plug-ins available on the
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
279 local machine.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
280
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
281 * **eric6_pluginrepository.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
282
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
283 This is a standalone variant of the plug-in repository window. It is used
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
284 to view the available plug-ins and download them to the local machine.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
285
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
286 * **eric6_pluginuninstall.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
287
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
288 This is a standalone utility to uninstall eric6 plug-ins.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
289
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
290 * **eric6_qregexp.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
291
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
292 This tool may be used to create regular expressions based on QRegExp.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
293
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
294 * **eric6_qregularexpression.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
295
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
296 This tool may be used to create regular expressions based on
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
297 QRegularExpression.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
298
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
299 * **eric6_re.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
300
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
301 This tool may be used to create Python regular expressions as used with the
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
302 re module.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
303
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
304 * **eric6_shell.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
305
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
306 This is a standalone, graphical Python shell application.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
307
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
308 * **eric6_snap.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
309
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
310 This tool may be used to create screenshots of the whole screen, individual
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
311 windows or selectable areas.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
312
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
313 * **eric6_sqlbrowser.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
314
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
315 This is a simple tool to inspect SQL databases. All database products
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
316 supported by Qt may be inspected. Note, that Qt database drivers may be
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
317 installed first.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
318
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
319 * **eric6_tray.py**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
320
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
321 This is the tray starter application. See above for some details.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
322
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
323 * **eric6_trpreviewer**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
324
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
325 This tool may be used to preview translations of Qt forms. Forms and
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
326 language files may be loaded separately. Multiple languages can be loaded
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
327 and the active language can be switched between the loaded ones.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
328
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
329 * **eric6_uipreviewer**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
330
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
331 This tool is used to preview Qt forms. The display may be switched between
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
332 the available Qt window styles.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
333
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
334 * **eric6_unittest**
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
335
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
336 This is a standalone tool to execute existing unit tests.
fc6530b432ad README: some updates and added a list of all included eric6 tools.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 7037
diff changeset
337
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
338 14. License
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
339 -----------
6958
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
340 eric6 (and the others) is released under the conditions of the GPLv3. See
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
341 separate license file ``LICENSE.GPL3`` for more details. Third party software
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
342 included in eric6 is released under their respective license and contained in
949c3c76cc8a setup.py: continued implementing support for setup.py and tested against test.pypi.org.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6942
diff changeset
343 the eric6 distribution for convenience.
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
344
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
345 15. Bugs and other reports
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
346 --------------------------
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
347 Please send bug reports, feature requests or contributions to eric bugs
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
348 address. After the IDE is installed you can use the "Report Bug..."
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
349 entry of the Help menu, which will send an email to
7037
4560e7a43588 README.rst: Fixed some issues in the text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6958
diff changeset
350 <eric-bugs@eric-ide.python-projects.org>. To request a new feature use the
4266
17c215c416ba Made some corrections to the various README files and converted them to reStructured Text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4003
diff changeset
351 "Request Feature..." entry of the Help menu, which will send an email to
7037
4560e7a43588 README.rst: Fixed some issues in the text.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 6958
diff changeset
352 <eric-featurerequest@eric-ide.python-projects.org>.
5079
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
353
afc7a0bfcbf7 Enhanced the README.rst file to cover the PyQt wheels as well.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 4313
diff changeset
354 Alternatively bugs may be reported via the eric6 issue tracker at
5375
c55d7340ef39 Changed references to the eric web site URL to use the secure protocol https://.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 5152
diff changeset
355 <https://die-offenbachs.homelinux.org/issues/>.

eric ide

mercurial