git404hub

what is papa fr?

bharadwaj-pendyala/papa — explained in plain English

Analysis updated 2026-05-18

4PythonAudience · developerComplexity · 2/5Setup · easy

tl;dr

Papa is a command-line tool that checks how readable your Markdown and text documents are, highlighting hard-to-read sentences, passive voice, and adverbs so you can simplify your writing before publishing.

vibe map

mindmap
  root((repo))
    What it does
      Checks readability
      Flags passive voice
      Highlights complex sentences
      Assigns grade levels
    How you use it
      Command line tool
      Python library
      CI pipeline gating
    Outputs
      Terminal report
      JSON for scripts
      Visual HTML report
    Tech stack
      Python
      textstat library
    Use cases
      Docs quality gates
      Pull request checks
      Writing simplification
    Roadmap
      Config file
      GitHub Action
      SARIF output

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

what do people make with this?

VIBE 1

Fail pull requests automatically when documentation gets too hard to read.

VIBE 2

Generate a visual HTML report that highlights difficult sentences in your docs.

VIBE 3

Check the readability grade of your Markdown files before publishing them.

VIBE 4

Run Papa as a Python library to build custom writing-quality automation.

what's the stack?

Pythontextstat

how it stacks up fr

bharadwaj-pendyala/papa1038lab/agnes-ai3eyedtiger/video2vrcemote
Stars444
LanguagePythonPythonPython
Setup difficultyeasyeasyeasy
Complexity2/52/51/5
Audiencedevelopervibe codervibe coder

Figures from each repo's GitHub metadata at analysis time.

how do i run it?

Difficulty · easy time til it works · 5min

in plain english

Papa is a readability checker for Markdown and plain text documents. It works like the Hemingway Editor, the popular web app that highlights hard-to-read sentences, but Papa is designed to run from the command line and fit into automated workflows. You can use it as a standalone command-line tool, as a Python library, or inside continuous integration pipelines to enforce writing quality standards on your documentation. It is currently alpha software, meaning it is still in early development. The tool scans your writing and assigns a readability grade using three established formulas: ARI, Flesch-Kincaid, and Gunning fog. It also flags specific problems in your prose, including sentences that are hard to read, passive voice, adverbs, and complex phrasing. When it processes Markdown files, it safely skips over things like code blocks, frontmatter, and inline code so it only evaluates your actual prose. Papa can produce output in three formats. The default is a terminal view that shows the grade, a summary of flagged issues, and specific line numbers with explanations. You can also request a JSON file, which includes precise character offsets for each finding and is intended for use by scripts or automated agents. The third option is a self-contained HTML report that highlights the flagged sentences visually, similar to the Hemingway app, and works offline with no external dependencies. A key feature is the ability to gate continuous integration. You can set a maximum acceptable grade level, and if your documentation exceeds that threshold, the tool exits with an error code. This causes the CI job to fail, which means a pull request with overly complex prose cannot be merged until the writing is simplified. The same command can be run locally before submitting a pull request. The roadmap includes planned features such as a configuration file, a dedicated GitHub Action, additional output formats like SARIF and Markdown for pull request annotations, and integrations with other writing tools. The project is built on an existing Python library called textstat for its readability calculations and adds its own rules for the style findings.

prompts (copy fr)

prompt 1
I want to enforce a maximum readability grade on my Markdown docs in GitHub Actions so PRs with overly complex prose fail automatically. Show me how to set this up using Papa.
prompt 2
I have a Markdown file called README.md. Show me the Papa command to generate a visual HTML report highlighting hard-to-read sentences, passive voice, and adverbs.
prompt 3
I need to run Papa from a Python script and get structured JSON output with exact line numbers and character offsets for each readability issue. Show me the code.
prompt 4
Show me how to run Papa from the command line to check my docs folder and see a readability grade plus a summary of flagged writing problems in the terminal.

Frequently asked questions

what is papa fr?

Papa is a command-line tool that checks how readable your Markdown and text documents are, highlighting hard-to-read sentences, passive voice, and adverbs so you can simplify your writing before publishing.

What language is papa written in?

Mainly Python. The stack also includes Python, textstat.

How hard is papa to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is papa for?

Mainly developer.

peek the repo → explain another one

This repo across BitVibe Labs

double-check against the repo, no cap.