ERIC7_API(1)

💖 ERIC7_API 💖

okay so bestie, welcome to the eric7_api page from the General Commands Manual — yes this is ERIC7_API(1) and yes we're doing the whole thing, no skimming, no skipping, periodt. ✨

🌸 NAME 🌸

eric7_api — the eric7 API generator, aka the lil tool that makes your editor go "ooh I know what that function is" 🧚

---

🦋 SYNOPSIS 🦋

eric7_api [options] files...

and files can be either Python modules, package directories or ordinary directories. all of the above, she's flexible 💅

---

🎀 DESCRIPTION 🎀

This manual page documents briefly the eric7_api command. And lowkey important tea: this manual page was written for the Debian distribution because the original program does not have a manual page. so like, we made it ourselves, we're so resourceful 🫶

So what does she actually do? eric7_api scans Python source code to generate API description files. Those files get used as tooltips and autocompletion suggestions by the QScintilla editor widget in eric7. it's giving "your editor finally knows things" and honestly? iconic. ✨

---

⭐ 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. (yes, the Info files, go read em, iykyk 😌)

• -b name or --base name — use the given name as the name of the base package. name her, she deserves it 💖
• -h or --help — show this help and exit. bye bestie 👋
• -o filename or --output=filename — write the API information to the named file. A %L placeholder is replaced by the language of the API file (see --language). cute lil variable moment 🎀
• --oldstyle — generate API files for QScintilla prior to 1.7. retro era, respect the elders 🙈
• -p or --private — include private methods and functions. let her see the secrets 🔥
• -R, -r or --recursive — perform a recursive search for Python files. down down down we go 🦋
• -t ext or --extension = ext — add the given *ext*ension to the list of file extensions. This option may be given multiple times. stack em up 💅
• -V or --version — show version information and exit. 🎀
• -x directory or --exclude=directory — specify a directory basename to be excluded. This option may be repeated multiple times. not her, not today 💀
• --exclude-file=pattern — specify a filename pattern of files to be excluded. This option may be repeated multiple times. same energy, files edition 🚫
• -l language or --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. multilingual queen 🌈

ngl bestie, --language defaults to 'Python' — don't forget or you'll get Python when you wanted Ruby, and that's a whole mood ruiner 😭

---

💜 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_fido2.1(1), eric7_hexeditor(1), eric7_iconeditor(1), eric7_mpy(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),

the whole friend group, honestly 👑✨

---

🌟 AUTHOR 🌟

eric7_api was written by Detlev Offenbach. king behavior 👑

---

🌈 AUTHOR 🌈

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

---

and that's the whole page bestie!! dated January 31, 2010, living under ERIC7_API(1) in the General Commands Manual forever, mwah 💅💖✨