Skip to main content

Small text statistics helpers for Python and the terminal

Project description

hermes-textstats

hermes-textstats is a small Python package for text statistics. It provides importable functions and a command-line interface for word counts, sentence counts, character counts, average word length, and reading-time estimates.

The name connects the package to the Hermes Agent workflow used in the course. The package itself is intentionally small: it gives students a concrete package that can be built, tested, documented, and published from DIVE/JupyterHub.

Motivation

When I write short text for assignments, quiz explanations, README files, or project reflections, I sometimes want quick feedback about length without opening another tool. This package gives a simple example: a student can paste a paragraph into Python, a notebook, or the terminal and immediately see word count, sentence count, character count, and estimated reading time.

Example use cases:

  • checking the length of a reflection paragraph before submitting it;
  • measuring a short quiz explanation inside DIVE/JupyterHub;
  • using a small package project to practice the Hermes Agent + git + PyPI workflow.

Installation

python -m pip install hermes-textstats

Quick Start

from hermes_textstats import analyze_text, count_words

text = "Hermes helps me build, test, and publish Python packages."
print(count_words(text))
summary = analyze_text(text)
print(summary)
hermes-textstats "Hermes helps me build, test, and publish Python packages."
hermes-textstats --json "Hermes helps me build, test, and publish Python packages."

API

  • count_words(text)
  • count_sentences(text)
  • count_characters(text, include_spaces=True)
  • average_word_length(text)
  • estimate_reading_time(text, words_per_minute=200)
  • analyze_text(text)

Development

python -m pip install -e ".[test]"
python -m pytest tests/ -v
python -m build
python -m twine check dist/*

Project Notes

  • Paper package summary contains the one-line summary, short motivation paragraph, and visual evidence for TALE 2026 notes.
  • Paper notes records what I built, what Hermes helped with, and what is already verified.
  • DIVE verification lists the commands to run in DIVE before saying the package is verified there.
  • Notebook demo demonstrates the Python API in a notebook-style workflow.
  • Demo transcript shows the package running from the command line.
  • Demo screencap is a screencap-style image made from the real CLI output.
  • Workflow diagram shows how DIVE, Hermes Agent, git, tests, docs, and TestPyPI/PyPI connect.

See docs/ACCOUNT_SETUP.md before publishing to TestPyPI, PyPI, or Telegram.

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

hermes_textstats-0.1.0.tar.gz (43.7 kB view details)

Uploaded Source

Built Distribution

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

hermes_textstats-0.1.0-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hermes_textstats-0.1.0.tar.gz
  • Upload date:
  • Size: 43.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for hermes_textstats-0.1.0.tar.gz
Algorithm Hash digest
SHA256 64ab42333979b3fd120d9736b023781186c063674971dbe73f4178d13b511fa9
MD5 f4c27f4ed0fec810435451e8cd167843
BLAKE2b-256 d02f5c862e11ecc5f80e1bc54c1e4c43bffd4c058cb7963a591b58f12585e34e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hermes_textstats-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b6e9c70d25ad6f642106d0632444a7ead05a2f439ed82581a33f1114ba0108ed
MD5 6c247844cafe9391beb7b833c68b8425
BLAKE2b-256 ea30d2352255796fad44487408d7facbca419fa2624d301c0b1a8b594b744d6c

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