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.4.tar.gz (2.1 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.4-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for longstrings-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f9b3bdad087b53000eb8bf0841934197994abecd70aff0b8ec4517aae96e617d
MD5 f3034d283568ea0fc298546a1ec6ddb0
BLAKE2b-256 93750790fad60d53281edd6d13fc839a59183149df996e37573e610f864f0d2e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for longstrings-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0143b5aa91113e39b4b464b0bd5ff4a860ca13be534bc99512f9fa755fa4716a
MD5 fcceffc6b06fcd799dd732a96854973c
BLAKE2b-256 39d789ee170e850c048c9cd0846d8690409949ab1f615781863e2615c7367d04

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