pythion 1.0.2

AI-powered CLI tool for generating Python documentation strings effortlessly

Pythion

Pythion is a command-line interface (CLI) tool designed to assist Python developers by generating documentation strings using AI. With an easy-to-use interface built on the Click library, Pythion provides a seamless way to enhance your Python projects with well-structured docstrings and documentation management.

Features

• Generate documentation strings for Python functions and classes.
• Iterate through documents in specified directories.
• Flexible options to include or exclude already documented functions.

Table of Contents

• Installation
• Usage
• Commands
• License

Installation

You can install Pythion via pip. Open your terminal and enter:

pip install pythion

Usage

After installing Pythion, you can invoke the command-line tool as follows:

pythion [OPTIONS] COMMAND [ARGS]...

Commands

1. make_docstr

Generates documentation for any given function or class name.

pythion make-docstr <root_dir>

• Arguments:
  • root_dir: The path to the root directory containing the Python files to analyze.

Example:

pythion make-docstr /path/to/dir

2. build-doc-cache

Bulk builds a documentation cache for functions and methods in a specified directory.

This cache then can later be used via iter-docs

pythion build-doc-cache <root_dir> [--use_all]

• Arguments:
  • root_dir: The directory path where the Python files are located.
• Options:
  • -ua, --use_all: If set, generates docstrings for all functions; otherwise, only for those without docstrings.

Example:

pythion build-doc-cache /path/to/dir --use_all

3. iter-docs

Iterates through the documentation cache.

pythion iter-docs <root_dir>

• Arguments:
  • root_dir: The path to the directory containing documents to be iterated.

Example:

pythion iter-docs /path/to/dir

NOTES

• You must have an OpenAI API key saves on your environment for the key OPENAI_API_KEY

License

This project is licensed under the MIT License. See the LICENSE file for details.