---
name: "eric3-api"
section: "1"
platform: "linux"
package: "eric"
version: "3.9.1-1"
release: "Debian 4.0 (Etch)"
platforms: ["linux"]
url: "https://new.carta.tech/eric3-api"
---

# eric3-api(1)

eric3 API generator

## NAME

eric3-api - eric3 API generator

## SYNOPSIS

**eric3-api** \[*options*\] *files*...

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

## DESCRIPTION

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

**eric3-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 eric3.

## 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.

- **-o filename or --output=filename**

  Write the API information to the named file.

- **-R, -r or --recursive**

  Perform a recursive search for Python files.

- **-x directory or --exclude=directory**

  Specify a directory basename to be excluded. This option may be repeated multiple times.

- **-V or --version**

  Show version information and exit.

- **-h or --help**

  Show this help and exit.

## SEE ALSO

[**eric3**(1)](/eric3/1.md), [**eric3-helpviewer**(1)](/eric3-helpviewer/1.md), [**eric3-qregexp**(1)](/eric3-qregexp/1.md), [**eric3-re**(1)](/eric3-re/1.md), [**eric3-doc**(1)](/eric3-doc/1.md), [**eric3-unittest**(1)](/eric3-unittest/1.md).\

## AUTHOR

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