philiprehberger-string-truncate 0.2.0

Truncate strings intelligently without cutting words

philiprehberger-string-truncate

Truncate strings intelligently without cutting words.

Installation

pip install philiprehberger-string-truncate

Usage

from philiprehberger_string_truncate import truncate, truncate_middle, truncate_path

truncate("Hello beautiful world", max_length=15)
# "Hello…"

truncate("Hello beautiful world", max_length=15, suffix="...")
# "Hello..."

truncate_middle("Hello beautiful world of code", max_length=20)
# "Hello bea…l of code"

truncate_path("/very/long/path/to/some/file.txt", max_length=25)
# "/very/long/.../file.txt"

Word-count truncation

from philiprehberger_string_truncate import truncate_words

truncate_words("one two three four five", max_words=3)
# "one two three..."

truncate_words("one two", max_words=5)
# "one two"

Wrapping

from philiprehberger_string_truncate import wrap

wrap("the quick brown fox jumps over the lazy dog", width=20)
# "the quick brown fox\njumps over the lazy\ndog"

wrap("first paragraph\n\nsecond paragraph", width=80)
# "first paragraph\n\nsecond paragraph"

API

Function / Class	Description
truncate(text, max_length, suffix="…", break_words=False)	Word-boundary truncation
truncate_middle(text, max_length, separator="…")	Keep start and end
truncate_path(path, max_length, separator="/", placeholder="...")	Path-aware truncation
truncate_words(text, max_words, suffix="...")	Truncate to a word count, appending suffix when shortened
wrap(text, width=80)	Wrap to lines at word boundaries; preserves paragraph breaks

Development

pip install -e .
python -m pytest tests/ -v

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT