logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

eric7_api - eric7 API generator

Author

       This  manual page was written by Torsten Marek <shlomme@gmx.net>, for the Debian project (but may be used
       by others).

                                                January  31, 2010                                   ERIC7_API(1)

Description

       This  manual  page  documents briefly the eric7_api command.  This manual page was written for the Debian
       distribution because the original program does not have a manual page.

       eric7_api scans Python source code to generate API descriptions files which are used to as  tooltips  and
       autocompletion suggestions by the QScintilla editor widget in eric7.

Name

       eric7_api - eric7 API generator

Options

       These  programs  follow  the  usual  GNU  command line syntax, with long options starting with two dashes
       (`-').  A summary of options is included below.  For a complete description, see the Info files.

       -bnameor--basename
              Use the given name as the name of the base package.

       -hor--help
              Show this help and exit.

       -ofilenameor--output=filename
              Write the API information to the named file. A '%L' placeholder is replaced by the language of the
              API file (see --language).

       --oldstyle
              Generate API files for QScintilla prior to 1.7.

       -por--private
              Include private methods and functions.

       -R,-ror--recursive
              Perform a recursive search for Python files.

       -textor--extension=ext
              Add the given extension to the list of file extensions.  This option may be given multiple times.

       -Vor--version
              Show version information and exit.

       -xdirectoryor--exclude=directory
              Specify a directory basename to be excluded.  This option may be repeated multiple times.

       --exclude-file=pattern
              Specify a filename pattern of files to be excluded.  This option may be repeated multiple times.

       -llanguageor--language=language
              Generate an API file for the given programming language.  Supported programming languages are:
                  * Python
                  * Python3
                  * Ruby The default is 'Python'.  This option may be repeated multiple times.

See Also

eric7_ide(1),  eric7_api(1),  eric7_browser(1),  eric7_compare(1),   eric7_configure(1),   eric7_diff(1),
       eric7_doc(1),   eric7_editor(1),  eric7_hexeditor(1),  eric7_iconeditor(1),  eric7_pdf(1),  eric7_pip(1),
       eric7_plugininstall(1), eric7_pluginrepository(1), eric7_pluginuninstall(1), eric7_qregularexpression(1),
       eric7_re(1),  eric7_shell(1),  eric7_snap(1),   eric7_sqlbrowser(1),   eric7_testing(1),   eric7_tray(1),
       eric7_trpreviewer(1), eric7_uipreviewer(1), eric7_virtualenv(1),

Synopsis

eric7_api [options] files...

       where files can be be either Python modules, package directories or ordinary directories.

See Also