flowmark 0.2.1__tar.gz → 0.3.1__tar.gz

flowmark-0.3.1/.copier-answers.yml

@@ -0,0 +1,9 @@
+# Changes here will be overwritten by Copier. Do not edit manually.
+_commit: 1742e95
+_src_path: gh:jlevy/simple-modern-uv
+package_author_email: joshua@cal.berkeley.edu
+package_author_name: Joshua Levy
+package_description: Better line wrapping and formatting for plaintext and Markdown
+package_github_org: jlevy
+package_name: flowmark
+package_slug: flowmark

flowmark-0.3.1/.github/workflows/ci.yml

@@ -0,0 +1,63 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: CI
+
+on:
+  push:
+    # Use ["main", "master"] for CI only on the default branch.
+    # Use ["**"] for CI on all branches.
+    branches: ["main", "master"]
+  pull_request:
+    branches: ["main", "master"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        # Update this as needed:
+
+        # Common platforms: ["ubuntu-latest", "macos-latest", "windows-latest"]
+        os: ["ubuntu-latest"]
+        python-version: ["3.10","3.11", "3.12", "3.13"]
+
+    # Linux only by default. Use ${{ matrix.os }} for other OSes.
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      # Generally following uv docs:
+      # https://docs.astral.sh/uv/guides/integration/github/
+
+      - name: Checkout (official GitHub action)
+        uses: actions/checkout@v4
+        with:
+          # Important for versioning plugins:
+          fetch-depth: 0
+
+      - name: Install uv (official Astral action)
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.5"
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up Python (using uv)
+        run: uv python install
+
+      # Alternately can use the official Python action:
+      # - name: Set up Python (using actions/setup-python)
+      #   uses: actions/setup-python@v5
+      #   with:
+      #     python-version: ${{ matrix.python-version }}
+
+      - name: Install all dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run linting
+        run: uv run python devtools/lint.py
+
+      - name: Run tests
+        run: uv run pytest

flowmark-0.3.1/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch: # Enable manual trigger.
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # Mandatory for OIDC.
+      contents: read
+    steps:
+      - name: Checkout (official GitHub action)
+        uses: actions/checkout@v4
+        with:
+          # Important for versioning plugins:
+          fetch-depth: 0
+
+      - name: Install uv (official Astral action)
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "0.6.5"
+          enable-cache: true
+          python-version: "3.12"
+
+      - name: Set up Python (using uv)
+        run: uv python install
+
+      - name: Install all dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI (using uv)
+        uses: pypa/gh-action-pypi-publish@release/v1

flowmark-0.3.1/.gitignore

@@ -0,0 +1,176 @@
+# Additions to standard GitHub .gitignore:
+tmp/
+trash/
+.kmd/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

flowmark-0.3.1/Makefile

@@ -0,0 +1,32 @@
+# Makefile for easy development workflows.
+# GitHub Actions call uv directly.
+
+.DEFAULT_GOAL := default
+
+.PHONY: default install_deps lint test build clean gen_test_docs
+
+default: install_deps lint test
+
+install_deps:
+	uv sync --all-extras --dev
+
+lint:
+	uv run python devtools/lint.py
+
+test:
+	uv run pytest
+
+build:
+	uv build
+
+clean:
+	-rm -rf dist/
+	-rm -rf *.egg-info/
+	-rm -rf .pytest_cache/
+	-rm -rf .mypy_cache/
+	-rm -rf .venv/
+	-find . -type d -name "__pycache__" -exec rm -rf {} +
+
+gen_test_docs:
+	poetry run flowmark tests/testdocs/testdoc.orig.md -o tests/testdocs/testdoc.out.plain.md
+	poetry run flowmark --semantic tests/testdocs/testdoc.orig.md -o tests/testdocs/testdoc.out.semantic.md

flowmark-0.3.1/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: flowmark
+Version: 0.3.1
+Summary: Better line wrapping and formatting for plaintext and Markdown
+Project-URL: Repository, https://github.com//flowmark
+Author-email: Joshua Levy <joshua@cal.berkeley.edu>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: <4.0,>=3.10
+Requires-Dist: marko>=2.1.2
+Requires-Dist: regex>=2024.11.6
+Requires-Dist: strif>=2.0.0
+Description-Content-Type: text/markdown
+
+# flowmark
+
+Flowmark is a new Python implementation of **text and Markdown line wrapping and
+filling**, with an emphasis on making **git diffs** and **LLM edits** to text documents
+easier to diff and review.
+
+In addition, it adds **support for Markdown** and offers **Markdown auto-formatting and
+normalization** as a library or from the command line.
+This is much like [markdownfmt](https://github.com/shurcooL/markdownfmt) or
+[prettier's Markdown support](https://prettier.io/blog/2017/11/07/1.8.0) but is pure
+Python and has (in my humble opinion) better options and defaults.
+
+## Installation
+
+The simplest way to use the tool is to use [uv](https://github.com/astral-sh/uv):
+
+```shell
+uv tool install flowmark
+```
+
+Or [pipx](https://github.com/pypa/pipx):
+
+```shell
+pipx install flowmark
+```
+
+Then
+
+```
+flowmark --help
+```
+
+To use as a library, use pip/poetry/uv to install
+[`flowmark`](https://pypi.org/project/flowmark/).
+
+## Use in VSCode/Cursor
+
+You can use Flowmark to auto-format Markdown on save in VSCode or Cursor.
+Install the "Run on Save" (`emeraldwalk.runonsave`) extension.
+Then add to your `settings.json`:
+
+```json
+  "emeraldwalk.runonsave": {
+    "commands": [
+        {
+            "match": "\\.md$",
+            "cmd": "flowmark --auto ${file}"
+        }
+    ]
+  }
+```
+
+The `--auto` option is just the same as `--inplace --nobackup --semantic`.
+
+## Use Cases
+
+- As a **command line formatter** to format text or Markdown files using the `flowmark`
+  command.
+
+- To **autoformat Markdown on save in VSCode/Cursor** or any other editor that supports
+  running a command on save.
+  Flowmark uses a readable format that makes diffs easy to read and use on GitHub.
+  It also normalizes all Markdown syntax variations (such as different header or
+  formatting styles). This can be especially useful for documentation and editing
+  workflows where clean diffs and minimal merge conflicts on GitHub are important.
+
+- As a **library to autoformat Markdown**. For example, it is great to normalize the
+  outputs from LLMs to be consistent, or to run on the inputs and outputs of LLM
+  transformations that edit text, so that the resulting diffs are clean.
+  Having this as a simple Python library makes this easy in AI-related document
+  pipelines.
+
+- As a **drop-in replacement library for Python's default
+  [`textwrap`](https://docs.python.org/3/library/textwrap.html)** but with more options.
+  It simplifies and generalizes that library, offering better control over **initial and
+  subsequent indentation** and **when to split words and lines**, e.g. using a word
+  splitter that won't break lines within HTML tags.
+
+- Flowmark has the option to to use **semantic line breaks** (using a heuristic to break
+  lines on sentences sentences when that is reasonable), which is an underrated feature
+  that can **make diffs on GitHub much more readable**. The the change may seem subtle
+  but avoids having paragraphs reflow for very small edits, which does a lot to
+  **minimize merge conflicts**. An example of what sentence-guided wrapping looks like,
+  see the
+  [Markdown source](https://github.com/jlevy/flowmark/blob/main/README.md?plain=1) of
+  this readme file.)
+
+- Very, very simple and fast **regex-based sentence splitting**. This should work fine
+  for English and many other latin/Cyrillic languages but it hasn't been tested on CJK.
+
+It aims to be small and simple and have only a few dependencies, currently only
+[`marko`](https://github.com/frostming/marko),
+[`regex`](https://pypi.org/project/regex/), and
+[`strif`](https://github.com/jlevy/strif).
+
+Because **YAML frontmatter** is common on Markdown files, the Markdown autoformat
+preserves all frontmatter (content between `---` delimiters at the front of a file).
+
+## Why a New Markdown Formatter?
+
+Previously I'd implemented something very similar with
+[for Atom](https://github.com/jlevy/atom-flowmark).
+I found the Markdown formatting conventions enforced by the that plugin worked really
+well for editing and publishing large or collaboratively edited documents.
+
+This is new, pure Python implementation.
+There are numerous needs for a tool like this on the command line and in Python.
+
+With LLM tools now using Markdown everywhere, there are enormous advantages to having
+very clean and well-formatted Markdown documents, since you can then cleanly see diffs
+or edits made by LLMs.
+
+If you are in a workspace where you are editing lots of text, having them all be
+Markdown with frontmatter, auto-formatted for every git commit makes for a *much* better
+experience.
+
+## Usage
+
+Flowmark can be used as a library or as a CLI.
+
+```
+$ flowmark --help
+usage: flowmark [-h] [-o OUTPUT] [-w WIDTH] [-p] [-s] [-i] [--nobackup] [file]
+
+Flowmark: Better line wrapping and formatting for plaintext and Markdown
+
+positional arguments:
+  file                 Input file (use '-' for stdin)
+
+options:
+  -h, --help           show this help message and exit
+  -o, --output OUTPUT  Output file (use '-' for stdout)
+  -w, --width WIDTH    Line width to wrap to
+  -p, --plaintext      Process as plaintext (no Markdown parsing)
+  -s, --semantic       Enable sentence-based line breaks (only applies to Markdown mode)
+  -i, --inplace        Edit the file in place (ignores --output)
+  --nobackup           Do not make a backup of the original file when using --inplace
+
+Flowmark provides enhanced text wrapping capabilities with special handling for
+Markdown content. It can:
+
+- Format Markdown with proper line wrapping while preserving structure
+  and normalizing Markdown formatting
+
+- Optionally break lines at sentence boundaries for better diff readability
+
+- Process plaintext with HTML-aware word splitting
+
+It is both a library and a command-line tool.
+
+Command-line usage examples:
+
+  # Format a Markdown file to stdout
+  flowmark README.md
+
+  # Format a Markdown file and save to a new file
+  flowmark README.md -o README_formatted.md
+
+  # Edit a file in-place (with or without making a backup)
+  flowmark --inplace README.md
+  flowmark --inplace --nobackup README.md
+
+  # Process plaintext instead of Markdown
+  flowmark --plaintext text.txt
+
+  # Use sentences to guide line breaks (good for many purposes git history and diffs)
+  flowmark --semantic README.md
+
+For more details, see: https://github.com/jlevy/flowmark
+```
+
+* * *
+
+*This project was built from
+[simple-modern-uv](https://github.com/jlevy/simple-modern-uv).*

flowmark-0.3.1/README.md

@@ -0,0 +1,175 @@
+# flowmark
+
+Flowmark is a new Python implementation of **text and Markdown line wrapping and
+filling**, with an emphasis on making **git diffs** and **LLM edits** to text documents
+easier to diff and review.
+
+In addition, it adds **support for Markdown** and offers **Markdown auto-formatting and
+normalization** as a library or from the command line.
+This is much like [markdownfmt](https://github.com/shurcooL/markdownfmt) or
+[prettier's Markdown support](https://prettier.io/blog/2017/11/07/1.8.0) but is pure
+Python and has (in my humble opinion) better options and defaults.
+
+## Installation
+
+The simplest way to use the tool is to use [uv](https://github.com/astral-sh/uv):
+
+```shell
+uv tool install flowmark
+```
+
+Or [pipx](https://github.com/pypa/pipx):
+
+```shell
+pipx install flowmark
+```
+
+Then
+
+```
+flowmark --help
+```
+
+To use as a library, use pip/poetry/uv to install
+[`flowmark`](https://pypi.org/project/flowmark/).
+
+## Use in VSCode/Cursor
+
+You can use Flowmark to auto-format Markdown on save in VSCode or Cursor.
+Install the "Run on Save" (`emeraldwalk.runonsave`) extension.
+Then add to your `settings.json`:
+
+```json
+  "emeraldwalk.runonsave": {
+    "commands": [
+        {
+            "match": "\\.md$",
+            "cmd": "flowmark --auto ${file}"
+        }
+    ]
+  }
+```
+
+The `--auto` option is just the same as `--inplace --nobackup --semantic`.
+
+## Use Cases
+
+- As a **command line formatter** to format text or Markdown files using the `flowmark`
+  command.
+
+- To **autoformat Markdown on save in VSCode/Cursor** or any other editor that supports
+  running a command on save.
+  Flowmark uses a readable format that makes diffs easy to read and use on GitHub.
+  It also normalizes all Markdown syntax variations (such as different header or
+  formatting styles). This can be especially useful for documentation and editing
+  workflows where clean diffs and minimal merge conflicts on GitHub are important.
+
+- As a **library to autoformat Markdown**. For example, it is great to normalize the
+  outputs from LLMs to be consistent, or to run on the inputs and outputs of LLM
+  transformations that edit text, so that the resulting diffs are clean.
+  Having this as a simple Python library makes this easy in AI-related document
+  pipelines.
+
+- As a **drop-in replacement library for Python's default
+  [`textwrap`](https://docs.python.org/3/library/textwrap.html)** but with more options.
+  It simplifies and generalizes that library, offering better control over **initial and
+  subsequent indentation** and **when to split words and lines**, e.g. using a word
+  splitter that won't break lines within HTML tags.
+
+- Flowmark has the option to to use **semantic line breaks** (using a heuristic to break
+  lines on sentences sentences when that is reasonable), which is an underrated feature
+  that can **make diffs on GitHub much more readable**. The the change may seem subtle
+  but avoids having paragraphs reflow for very small edits, which does a lot to
+  **minimize merge conflicts**. An example of what sentence-guided wrapping looks like,
+  see the
+  [Markdown source](https://github.com/jlevy/flowmark/blob/main/README.md?plain=1) of
+  this readme file.)
+
+- Very, very simple and fast **regex-based sentence splitting**. This should work fine
+  for English and many other latin/Cyrillic languages but it hasn't been tested on CJK.
+
+It aims to be small and simple and have only a few dependencies, currently only
+[`marko`](https://github.com/frostming/marko),
+[`regex`](https://pypi.org/project/regex/), and
+[`strif`](https://github.com/jlevy/strif).
+
+Because **YAML frontmatter** is common on Markdown files, the Markdown autoformat
+preserves all frontmatter (content between `---` delimiters at the front of a file).
+
+## Why a New Markdown Formatter?
+
+Previously I'd implemented something very similar with
+[for Atom](https://github.com/jlevy/atom-flowmark).
+I found the Markdown formatting conventions enforced by the that plugin worked really
+well for editing and publishing large or collaboratively edited documents.
+
+This is new, pure Python implementation.
+There are numerous needs for a tool like this on the command line and in Python.
+
+With LLM tools now using Markdown everywhere, there are enormous advantages to having
+very clean and well-formatted Markdown documents, since you can then cleanly see diffs
+or edits made by LLMs.
+
+If you are in a workspace where you are editing lots of text, having them all be
+Markdown with frontmatter, auto-formatted for every git commit makes for a *much* better
+experience.
+
+## Usage
+
+Flowmark can be used as a library or as a CLI.
+
+```
+$ flowmark --help
+usage: flowmark [-h] [-o OUTPUT] [-w WIDTH] [-p] [-s] [-i] [--nobackup] [file]
+
+Flowmark: Better line wrapping and formatting for plaintext and Markdown
+
+positional arguments:
+  file                 Input file (use '-' for stdin)
+
+options:
+  -h, --help           show this help message and exit
+  -o, --output OUTPUT  Output file (use '-' for stdout)
+  -w, --width WIDTH    Line width to wrap to
+  -p, --plaintext      Process as plaintext (no Markdown parsing)
+  -s, --semantic       Enable sentence-based line breaks (only applies to Markdown mode)
+  -i, --inplace        Edit the file in place (ignores --output)
+  --nobackup           Do not make a backup of the original file when using --inplace
+
+Flowmark provides enhanced text wrapping capabilities with special handling for
+Markdown content. It can:
+
+- Format Markdown with proper line wrapping while preserving structure
+  and normalizing Markdown formatting
+
+- Optionally break lines at sentence boundaries for better diff readability
+
+- Process plaintext with HTML-aware word splitting
+
+It is both a library and a command-line tool.
+
+Command-line usage examples:
+
+  # Format a Markdown file to stdout
+  flowmark README.md
+
+  # Format a Markdown file and save to a new file
+  flowmark README.md -o README_formatted.md
+
+  # Edit a file in-place (with or without making a backup)
+  flowmark --inplace README.md
+  flowmark --inplace --nobackup README.md
+
+  # Process plaintext instead of Markdown
+  flowmark --plaintext text.txt
+
+  # Use sentences to guide line breaks (good for many purposes git history and diffs)
+  flowmark --semantic README.md
+
+For more details, see: https://github.com/jlevy/flowmark
+```
+
+* * *
+
+*This project was built from
+[simple-modern-uv](https://github.com/jlevy/simple-modern-uv).*