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.0.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.0-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: longstrings-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 202a88076bf22b16504ff5d15ded8a7535f7994763279eed30692bf0aaa3ea3d
MD5 4f2e37c0b211f86225500078580d9057
BLAKE2b-256 b4c07a81628bfca9b8ccffbb5a3e592c56eaccbe72d3c232dcf4e843efa9cf7d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for longstrings-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c276e8a5d0b17764b1a9708078f1e8884ed3c46eda8575e0e8ae2f17079e7275
MD5 5e8f16067d8c6b307a586da096e578c3
BLAKE2b-256 9c93321297bc570324577076cfa9a2887a341acabdfc518081dd8d35f586f65c

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