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

Uploaded Python 3

File details

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

File metadata

  • Download URL: longstrings-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 6d25317613cbb0a82707e2e05e46d4704673c6e51d3f7c77d429b9355d6a4c98
MD5 66913c2f70052e85506af6e678ef81aa
BLAKE2b-256 599089fab02260b434a19fb17ba1a5bc076873d0870aa21f6823baf3a19d37a0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for longstrings-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f545278baf624e95704c6a40890926d378867372428f36acfea5909950e678f5
MD5 751086a468b662c82429c60cc4a28f79
BLAKE2b-256 fae7a6deee506f51990d7cbe55e4159f1c82fe637e3e32cb75e03c759d981a4f

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