Skip to main content

Find long string comments in Python code

Project description

Find long comments and docstrings in a Python codebase.

In new and quickly-evovling projects, documentation often ends up in comments and docstrings rather than in formal docs. longstrings is a command line utility to find and emit these long comments for perusal.

Usage

usage: longstrings.exe [-h] [--min-length MIN_LENGTH] path

positional arguments:
  path                  Path to the file or directory

options:
  -h, --help            show this help message and exit
  --min-length MIN_LENGTH
                        How many characters does a comment have to be before it's considered 'long'

Examples

uvx longstrings ~/somefile.py
uvx longstrings ~/some_codebase/some_module --min-length 500

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

longstrings-0.1.1.tar.gz (1.9 kB view details)

Uploaded Source

Built Distribution

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

longstrings-0.1.1-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file longstrings-0.1.1.tar.gz.

File metadata

  • Download URL: longstrings-0.1.1.tar.gz
  • Upload date:
  • Size: 1.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.5

File hashes

Hashes for longstrings-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8de9cbe5c2a0dbb18cfaafb83de97493dc8da1c2e1016c3152de7e467b8a5aa3
MD5 ab14cd6afc152e5d96ac6d799019e72c
BLAKE2b-256 1e3107ecb50fb0e5a228ef9b31cdedad24d6269cff2446922721af0068307723

See more details on using hashes here.

File details

Details for the file longstrings-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for longstrings-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1266943ebe51570d3e747a6a2cfe68512b870f190578627e07585eb6a5367ec2
MD5 d58833379d008677a846f7431b86363f
BLAKE2b-256 4b0a492c6f195082c7538344f6375e4e0c5f6a1df80cac37f588aa73b3595f61

See more details on using hashes here.

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