Skip to main content

Generate Python docstrings automatically with LLM and syntax trees.

Project description

llm-docsmith

Generate Python docstrings automatically with LLM and syntax trees.

Installation

Install this plugin in the same environment as LLM.

llm install llm-docsmith

Usage

Pass a Python file as argument to llm docsmith:

llm docsmith ./scripts/main.py

The file will be edited to include the generated docstrings.

Options:

  • -m/--model: Use a model other than the configured LLM default model
  • -o/--output: Only show the modified code, without modifying the file
  • -v/--verbose: Verbose output of prompt and response

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llm_docsmith-0.1.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llm_docsmith-0.1-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file llm_docsmith-0.1.tar.gz.

File metadata

  • Download URL: llm_docsmith-0.1.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for llm_docsmith-0.1.tar.gz
Algorithm Hash digest
SHA256 9fbcd97829968bc87cb3192f3d0331631fbc47dbad670067977dd781d03cf4ba
MD5 1d377b75cf03beae1fe82c8bfc8d1be0
BLAKE2b-256 1f2b8d5a17c6a2c418a7e45b23eb62cc04ba1ce7bf1b084d28f5e8c078041fbe

See more details on using hashes here.

Provenance

The following attestation bundles were made for llm_docsmith-0.1.tar.gz:

Publisher: publish.yml on mathpn/llm-docsmith

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file llm_docsmith-0.1-py3-none-any.whl.

File metadata

  • Download URL: llm_docsmith-0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for llm_docsmith-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 788f4c743b800b0a65f1b1b3d33bc7b9bbacb7849ade0fba699448aff83a0dff
MD5 bc5b47750710a08885f91505671044fe
BLAKE2b-256 0035fbd80c509363e80946b8b0ab5c313bd2f5a1580c5bcc23568242ee2f8862

See more details on using hashes here.

Provenance

The following attestation bundles were made for llm_docsmith-0.1-py3-none-any.whl:

Publisher: publish.yml on mathpn/llm-docsmith

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page