README.md

PyAPIReference

---

PyAPIReference is a GUI application to generate API References for Python modules.

Join our Discord server to keep updated.

Features

• Dark and light theme (using https://github.com/5yutan5/PyQtDarkTheme).
• Inspect a Python module and convert it into a tree.
• Export the tree as JSON, YAML or PREFS.
• Filter members to include in the tree (by type).
• Customize the color used to display different types in the tree (color pattern).
• Convert tree to Markdown (the Markdown will be the API Reference).
• Select the members to include in the Markdown.
• Markdown editor to edit the API Reference.
• Live preview of the Markdown.
• Export the Markdown API Reference as HTML, Markdown or ReStructuredText.

Installation

WORK IN PROGRESS.

Contribute

Feel free to contribute, join our Discord server for more information.

Screenshots

Test it from source code

1. First you will need to clone this repository by pasting this command into your terminal:

git clone https://github.com/Patitotective/PyAPIReference

If you don't have git installed download it.

2. Then enter to PyAPIReference directory inside PyAPIReference directory:

cd PyAPIReference/PyAPIReference

3. Install the requirements:

• Windows:

pip install -r requirements.txt

• Linux/MacOS:

pip3 install -r requirements.txt

4. Now you can simply run main.py:

• Windows:

python main.py

• Linux/MacOSX:

python3 main.py

About

• Website: https://patitotective.github.io/PyAPIReference/.
• Changelog: https://github.com/Patitotective/PyAPIReference/blob/main/CHANGELOG.md.
• GitHub: https://github.com/Patitotective/PyAPIReference.
• Discord server: https://discord.gg/as85Q4GnR6.
• Patitotective:
  • Discord: Patitotective#0127.
  • GitHub: https://github.com/Patitotective.
  • Email: [email protected].
• Sharkface:
  • Discord: Sharkface#9495.
  • GitHub: https://github.com/devp4.