ERIC6_API(1)

💖 ERIC6_API — eric6 API generator 💖

okay bestie, welcome to the eric6_api(1) page from the General Commands Manual, and let me tell you, this one is a little sleeper hit 🎀 it's not flashy but it does SO much behind the scenes. grab a strawberry drink 🍓 and let's go.

---

✨ SYNOPSIS ✨

eric6_api [options] files...

and bestie, those files? they can be any of these three things:

• Python modules 🐍
• package directories 📦
• or just, like, ordinary directories

no cap, it's flexible like that 💅

---

🌸 DESCRIPTION 🌸

so this manual page documents the eric6_api command briefly — like, the short version, the sparknotes, the yassified summary ✨

and real talk: this page was written for the Debian distribution, because the original program straight up does not have a manual page. so Debian said "fine, I'll do it myself" 💀 iconic behaviour honestly.

what does eric6_api actually do tho? okay so: it scans Python source code 👀 and it generates API description files. those files get used as tooltips and autocompletion suggestions by the QScintilla editor widget in eric6. so every time you hover over something in the editor and a little bubble tells you what it is?? that's this. that's the girl. main character energy fr fr 👑

---

🦋 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 📖

• -b name or --base name — use the given name as the name of the base package 🏷️
• -h or --help — show this help and exit. bye bestie 👋
• -o filename or --output=filename — write the API information to the named filename. a '%L' placeholder gets replaced by the language of the API file (peep --language for that one 👀)
• --oldstyle — generate API files for QScintilla prior to 1.7. vintage vibes, retro era 🕰️
• -p or --private — include private methods and functions 🙈 nothing is off limits, we're nosy
• -R, -r or --recursive — perform a recursive search for Python files. it goes DEEP 🔥
• -t ext or --extension = ext — add the given ext to the list of file extensions. this option may be given multiple times 🔁
• -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 🚫
• --exclude-file=pattern — specify a filename pattern of files to be excluded. this option may be repeated multiple times 🚫
• -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 🔁

heads up bestie: -t, -x, --exclude-file and -l are all repeatable — you can stack them like bracelets, they're not one-and-done 💅

---

👑 SEE ALSO 👑

the whole eric6 girl gang is here, go say hi:

eric6(1), eric6_browser(1), eric6_compare(1), eric6_configure(1), eric6_diff(1), eric6_doc(1), eric6_editor(1), eric6_helpviewer(1), eric6_iconeditor(1), eric6_plugininstall(1), eric6_pluginrepository(1), eric6_pluginuninstall(1), eric6_qregexp(1), eric6_re(1), eric6_shell(1), eric6_sqlbrowser(1), eric6_tray(1), eric6_trpreviewer(1), eric6_uipreviewer(1), eric6_unittest(1), eric6_webbrowser(1)

---

🎀 AUTHOR 🎀

this manual page was written by Torsten Marek <shlomme@gmx.net>, for the Debian project (but may be used by others) 🫶 shoutout Torsten, doing the community a solid.

---

and that's the whole page bestie!! this version lives in the General Commands Manual as ERIC6_API(1), and the footer stamp on it says January 31, 2010 — so yeah, it's giving 2010 and it's still out here serving 💜 go generate some API files, you've got this 🦋✨