Sat, 14 Dec 2024 13:03:11 +0100
pip Interface
- Changed the package search function to open an external web browser with the package search term (PyPI does not support programmatic search anymore).
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
1 | <!DOCTYPE html> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
2 | <html><head> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
3 | <title>eric7.eric7_api</title> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
4 | <meta charset="UTF-8"> |
8596
d64760b2da50
Documentation Generator: streamlined the code to use an external style sheet file.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
8372
diff
changeset
|
5 | <link rel="stylesheet" href="styles.css"> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
6 | </head> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
7 | <body> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
8 | <a NAME="top" ID="top"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
9 | <h1>eric7.eric7_api</h1> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
10 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
11 | eric API Generator. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
12 | </p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
13 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
14 | This is the main Python script of the API generator. It is |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
15 | this script that gets called via the API generation interface. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
16 | This script can be used via the commandline as well. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
17 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10303
diff
changeset
|
18 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
19 | <h3>Global Attributes</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
20 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
21 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
22 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10303
diff
changeset
|
23 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
24 | <h3>Classes</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
25 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
26 | <tr><td>None</td></tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
27 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10303
diff
changeset
|
28 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
29 | <h3>Functions</h3> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
30 | <table> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
31 | <tr> |
10303
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
32 | <td><a href="#createArgumentParser">createArgumentParser</a></td> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
33 | <td>Function to create an argument parser.</td> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
34 | </tr> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
35 | <tr> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
36 | <td><a href="#main">main</a></td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
37 | <td>Main entry point into the application.</td> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
38 | </tr> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
39 | </table> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10303
diff
changeset
|
40 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
41 | <hr /> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
42 | <hr /> |
10303
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
43 | <a NAME="createArgumentParser" ID="createArgumentParser"></a> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
44 | <h2>createArgumentParser</h2> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
45 | <b>createArgumentParser</b>(<i></i>) |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
46 | <p> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
47 | Function to create an argument parser. |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
48 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10303
diff
changeset
|
49 | |
10303
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
50 | <dl> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
51 | <dt>Return:</dt> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
52 | <dd> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
53 | created argument parser object |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
54 | </dd> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
55 | </dl> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
56 | <dl> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
57 | <dt>Return Type:</dt> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
58 | <dd> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
59 | argparse.ArgumentParser |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
60 | </dd> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
61 | </dl> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
62 | <div align="right"><a href="#top">Up</a></div> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
63 | <hr /> |
ee1aadab1215
Changed code to use the 'argparse' module to parse the command line parameters instead of using own code.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
9209
diff
changeset
|
64 | <hr /> |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
65 | <a NAME="main" ID="main"></a> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
66 | <h2>main</h2> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
67 | <b>main</b>(<i></i>) |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
68 | <p> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
69 | Main entry point into the application. |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
70 | </p> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10303
diff
changeset
|
71 | |
8372
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
72 | <div align="right"><a href="#top">Up</a></div> |
e0227a7c850e
Generated source docu for eric7.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff
changeset
|
73 | <hr /> |
10479
856476537696
Fine tuned the source code documentation template and regenerated the source code documentation.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
10303
diff
changeset
|
74 | </body></html> |