This extension uses docstring-gen library for generating documentation for your Python code. docstring-gen is an easy-to-use Python library that uses OpenAI's Codex model to automatically generate Google-style docstrings for Python codebase. The library is capable of reading both Jupyter notebooks and Python files, and seamlessly adds meaningful docstrings to classes and functions that lack documentation. By using docstring-gen, developers can automatically generate docstrings for their codebase, resulting in time savings and improved documentation quality.
Requirements: The following packages must be installed prior to proceeding:
pip install docstring-genNote: The docstring-gen library uses OpenAI’s Codex model to generate docstrings for your Python classes and functions. In order to use this extension, you’ll need to create an API key for OpenAI. Once you have your API key, store it in the OPENAI_API_KEY environment variable. This is a necessary step for the extension to work.
Then the extension provides
- a toolbar button
- a keyboard shortcut for generating docstring for the current code-cell (default: Ctrl-G)
- a keyboard shortcut for generating docstring for whole code-cells (default: Ctrl-Shift-G)
Please ensure jupyter-contrib-nbextensions is installed before installing the extension
To install the extension, simply run the following commands in your terminal:
jupyter nbextension install https://github.com/airtai/jupyter-docstring-gen/archive/main.zip --user
jupyter nbextension enable jupyter-docstring-gen-main/jupyter-docstring-genCopyright © 2023 onwards airt technologies ltd, Inc.
This project is licensed under the terms of the Apache License 2.0