flowmark 0.4.0__tar.gz → 0.4.2__tar.gz

{flowmark-0.4.0 → flowmark-0.4.2}/.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier. Do not edit manually.
-_commit: v0.2.0
+_commit: v0.2.7
 _src_path: gh:jlevy/simple-modern-uv
 package_author_email: joshua@cal.berkeley.edu
 package_author_name: Joshua Levy

{flowmark-0.4.0 → flowmark-0.4.2}/.github/workflows/ci.yml

@@ -40,7 +40,8 @@ jobs:
       - name: Install uv (official Astral action)
         uses: astral-sh/setup-uv@v5
         with:
-          version: "0.6.5"
+          # Update this as needed:
+          version: "0.6.14"
           enable-cache: true
           python-version: ${{ matrix.python-version }}
 

{flowmark-0.4.0 → flowmark-0.4.2}/.github/workflows/publish.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Install uv (official Astral action)
         uses: astral-sh/setup-uv@v5
         with:
-          version: "0.6.5"
+          version: "0.6.14"
           enable-cache: true
           python-version: "3.12"
 

{flowmark-0.4.0 → flowmark-0.4.2}/Makefile

@@ -1,5 +1,6 @@
 # Makefile for easy development workflows.
-# GitHub Actions call uv directly.
+# See development.md for docs.
+# Note GitHub Actions call uv directly, not this Makefile.
 
 .DEFAULT_GOAL := default
 

flowmark-0.4.0/README.md → flowmark-0.4.2/PKG-INFO

@@ -1,3 +1,27 @@
+Metadata-Version: 2.4
+Name: flowmark
+Version: 0.4.2
+Summary: Better line wrapping and formatting for plaintext and Markdown
+Project-URL: Repository, https://github.com/jlevy/flowmark
+Author-email: Joshua Levy <joshua@cal.berkeley.edu>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: <4.0,>=3.10
+Requires-Dist: marko>=2.1.2
+Requires-Dist: regex>=2024.11.6
+Requires-Dist: strif>=2.0.0
+Requires-Dist: typing-extensions>=4.12.2
+Description-Content-Type: text/markdown
+
 # flowmark
 
 Flowmark is a new Python implementation of **text and Markdown line wrapping and
@@ -129,8 +153,7 @@ experience.
 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]
+usage: flowmark [-h] [-o OUTPUT] [-w WIDTH] [-p] [-s] [-i] [--nobackup] [--auto] [--version] [file]
 
 Flowmark: Better line wrapping and formatting for plaintext and Markdown
 
@@ -142,9 +165,11 @@ options:
   -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)
+  -s, --semantic       Enable semantic (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
+  --auto               Same as `--inplace --nobackup --semantic`, as a convenience for auto-formatting files
+  --version            Show version information and exit
 
 Flowmark provides enhanced text wrapping capabilities with special handling for
 Markdown content. It can:
@@ -173,12 +198,32 @@ Command-line usage examples:
   # Process plaintext instead of Markdown
   flowmark --plaintext text.txt
 
-  # Use sentences to guide line breaks (good for many purposes git history and diffs)
+  # Use semantic line breaks (based on sentences, which is helpful to reduce
+  # irrelevant line wrap diffs in git history)
   flowmark --semantic README.md
 
 For more details, see: https://github.com/jlevy/flowmark
 ```
 
+## Other Notes
+
+- This enables
+  [GitHub-flavored Markdown support](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
+  using
+  [Marko's extension](https://github.com/frostming/marko/blob/master/marko/ext/footnote.py).
+
+- GFM-style tables are supported and also auto-formatted.
+
+- GFM-style footnotes are supported.
+  But note these aren't actually in the GFM spec, but we follow
+  [micromark's conventions](https://github.com/frostming/marko/blob/master/marko/ext/footnote.py).
+
+## Project Docs
+
+For how to install uv and Python, see [installation.md](installation.md).
+
+For development workflows, see [development.md](development.md).
+
 For instructions on publishing to PyPI, see [publishing.md](publishing.md).
 
 * * *

flowmark-0.4.0/PKG-INFO → flowmark-0.4.2/README.md

@@ -1,18 +1,3 @@
-Metadata-Version: 2.4
-Name: flowmark
-Version: 0.4.0
-Summary: Better line wrapping and formatting for plaintext and Markdown
-Project-URL: Repository, https://github.com/jlevy/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
-Requires-Dist: typing-extensions>=4.12.2
-Description-Content-Type: text/markdown
-
 # flowmark
 
 Flowmark is a new Python implementation of **text and Markdown line wrapping and
@@ -144,8 +129,7 @@ experience.
 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]
+usage: flowmark [-h] [-o OUTPUT] [-w WIDTH] [-p] [-s] [-i] [--nobackup] [--auto] [--version] [file]
 
 Flowmark: Better line wrapping and formatting for plaintext and Markdown
 
@@ -157,9 +141,11 @@ options:
   -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)
+  -s, --semantic       Enable semantic (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
+  --auto               Same as `--inplace --nobackup --semantic`, as a convenience for auto-formatting files
+  --version            Show version information and exit
 
 Flowmark provides enhanced text wrapping capabilities with special handling for
 Markdown content. It can:
@@ -188,12 +174,32 @@ Command-line usage examples:
   # Process plaintext instead of Markdown
   flowmark --plaintext text.txt
 
-  # Use sentences to guide line breaks (good for many purposes git history and diffs)
+  # Use semantic line breaks (based on sentences, which is helpful to reduce
+  # irrelevant line wrap diffs in git history)
   flowmark --semantic README.md
 
 For more details, see: https://github.com/jlevy/flowmark
 ```
 
+## Other Notes
+
+- This enables
+  [GitHub-flavored Markdown support](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
+  using
+  [Marko's extension](https://github.com/frostming/marko/blob/master/marko/ext/footnote.py).
+
+- GFM-style tables are supported and also auto-formatted.
+
+- GFM-style footnotes are supported.
+  But note these aren't actually in the GFM spec, but we follow
+  [micromark's conventions](https://github.com/frostming/marko/blob/master/marko/ext/footnote.py).
+
+## Project Docs
+
+For how to install uv and Python, see [installation.md](installation.md).
+
+For development workflows, see [development.md](development.md).
+
 For instructions on publishing to PyPI, see [publishing.md](publishing.md).
 
 * * *

{flowmark-0.4.0 → flowmark-0.4.2}/devtools/lint.py

@@ -1,6 +1,7 @@
 import subprocess
 
 from funlog import log_calls
+from rich import get_console, reconfigure
 from rich import print as rprint
 
 # Update as needed.
@@ -8,6 +9,9 @@ SRC_PATHS = ["src", "tests", "devtools"]
 DOC_PATHS = ["README.md"]
 
 
+reconfigure(emoji=not get_console().options.legacy_windows)  # No emojis on legacy windows.
+
+
 def main():
     rprint()
 
@@ -20,9 +24,9 @@ def main():
     rprint()
 
     if errcount != 0:
-        rprint(f"[bold red]✗ Lint failed with {errcount} errors.[/bold red]")
+        rprint(f"[bold red]:x: Lint failed with {errcount} errors.[/bold red]")
     else:
-        rprint("[bold green]✔️ Lint passed![/bold green]")
+        rprint("[bold green]:white_check_mark: Lint passed![/bold green]")
     rprint()
 
     return errcount
@@ -31,7 +35,7 @@ def main():
 @log_calls(level="warning", show_timing_only=True)
 def run(cmd: list[str]) -> int:
     rprint()
-    rprint(f"[bold green]❯ {' '.join(cmd)}[/bold green]")
+    rprint(f"[bold green]:arrow_forward: {' '.join(cmd)}[/bold green]")
     errcount = 0
     try:
         subprocess.run(cmd, text=True, check=True)

flowmark-0.4.2/installation.md

@@ -0,0 +1,27 @@
+## Installing uv and Python
+
+This project is set up to use [**uv**](https://docs.astral.sh/uv/), the new package
+manager for Python. `uv` replaces traditional use of `pyenv`, `pipx`, `poetry`, `pip`,
+etc. This is a quick cheat sheet on that:
+
+On macOS or Linux, if you don't have `uv` installed, a quick way to install it:
+
+```shell
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+For macOS, you prefer [brew](https://brew.sh/) you can install or upgrade uv with:
+
+```shell
+brew update
+brew install uv
+```
+
+See [uv's docs](https://docs.astral.sh/uv/getting-started/installation/) for more
+installation methods and platforms.
+
+Now you can use uv to install a current Python environment:
+
+```shell
+uv python install 3.13 # Or pick another version.
+```

{flowmark-0.4.0 → flowmark-0.4.2}/pyproject.toml

@@ -3,6 +3,7 @@
 [project.urls]
 Repository = "https://github.com/jlevy/flowmark"
 # Homepage = "https://..."
+# Documentation = "https://..."
 
 [project]
 name = "flowmark"
@@ -15,6 +16,24 @@ license = "MIT"
 requires-python = ">=3.10,<4.0"
 dynamic = ["version"]
 
+# https://pypi.org/classifiers/
+# Adjust as needed:
+classifiers = [
+    # Adjust as needed:
+    "Development Status :: 4 - Beta",
+    # "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+    # Include this to avoid accidentally publishing to PyPI:
+    # "Private :: Do Not Upload",
+]
+
 dependencies = [
     "marko>=2.1.2",
     "regex>=2024.11.6",
@@ -22,6 +41,7 @@ dependencies = [
     "typing-extensions>=4.12.2",
 ]
 
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.5",
@@ -38,6 +58,7 @@ dev = [
 flowmark = "flowmark.cli:main"
 
 
+
 # ---- Build system ----
 
 # Dynamic versioning from:
@@ -58,6 +79,11 @@ vcs = "git"
 style = "pep440"
 bump = "true"
 
+[tool.hatch.build.targets.wheel]
+# The source location for the package.
+packages = ["src/flowmark"]
+
+
 # ---- Settings ----
 
 [tool.ruff]
@@ -65,8 +91,8 @@ bump = "true"
 line-length = 100
 
 [tool.ruff.lint]
-# See: https://docs.astral.sh/ruff/rules/
 select = [
+    # See: https://docs.astral.sh/ruff/rules/
     # Basic list from: https://docs.astral.sh/ruff/linter/#rule-selection
     "E", # https://docs.astral.sh/ruff/rules/#error-e
     "F", # https://docs.astral.sh/ruff/rules/#pyflakes-f
@@ -81,6 +107,7 @@ select = [
 
 ]
 ignore = [
+    # Disable some rules that are overly pedantic. Add/remove as desired:
     "E501", # https://docs.astral.sh/ruff/rules/line-too-long/
     "E402", # https://docs.astral.sh/ruff/rules/module-import-not-at-top-of-file/
     "E731", # https://docs.astral.sh/ruff/rules/lambda-assignment/
@@ -101,28 +128,38 @@ ignore = [
     "ISC002", # https://docs.astral.sh/ruff/rules/multi-line-implicit-string-concatenation/
 ]
 
+[tool.basedpyright]
 # BasedPyright currently seems like the best type checker option, much faster
 # than mypy and with a good extension for VSCode/Cursor.
 # https://marketplace.visualstudio.com/items?itemName=detachhead.basedpyright
 # https://docs.basedpyright.com/latest/configuration/config-files/#sample-pyprojecttoml-file
-[tool.basedpyright]
 include = ["src", "tests", "devtools"]
-# Make ignoring easier:
+
+# By default BasedPyright is very strict, so you almost certainly want to disable
+# some of the rules.
+# First, these turn off warnings about (yes) how you ignore warnings:
 reportIgnoreCommentWithoutRule = false
 reportUnnecessaryTypeIgnoreComment = false
-# Typically noisy warnings, comment/uncomment as desired:
+# A few typically noisy warnings are next.
+# How many you enable is up to you. The first few are off by default, but you can
+# comment/uncomment these as desired:
 reportMissingTypeStubs = false
 reportUnusedCallResult = false
+reportAny = false
+reportExplicitAny = false
+reportImplicitStringConcatenation = false
+# reportUnreachable = false
+# reportUnusedParameter = false
+# reportPrivateImportUsage = false
+# reportPrivateLocalImportUsage = false
 # reportMissingImports = false
 # reportUnnecessaryIsInstance = false
 # reportUnreachable = false
-reportAny = false
-reportExplicitAny = false
-reportUnusedParameter = false
 # reportUnknownVariableType = false
 # reportUnknownArgumentType = false
 
 [tool.codespell]
+# Add here as needed:
 # ignore-words-list = "foo,bar"
 skip = "tests/testdocs/*.md"
 

flowmark-0.4.2/src/flowmark/cleanups.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from collections.abc import Callable
+
+from marko import block, inline
+from marko.block import Document
+from marko.element import Element
+
+ContainerElement = (
+    block.Document,
+    block.Quote,
+    block.List,
+    block.ListItem,
+    block.Paragraph,  # Paragraphs contain inline elements
+    block.Heading,  # Already handled, but include for completeness if structure changes
+    inline.Emphasis,
+    inline.StrongEmphasis,
+    inline.Link,
+)
+
+
+def transform_tree(element: Element, transformer: Callable[[Element], None]) -> None:
+    """
+    Recursively traverse the element tree and apply a transformer function to each node.
+    """
+    transformer(element)
+
+    # Recursively process children for known container types
+    if isinstance(element, ContainerElement):
+        # Now we know element has a .children attribute that's a Sequence[Element] or str
+        # We only care about processing Element children
+        if isinstance(element.children, list):
+            # Create a copy for safe iteration if modification occurs
+            current_children = list(element.children)
+            for child in current_children:
+                transform_tree(child, transformer)
+
+
+def _unbold_heading_transformer(element: Element) -> None:
+    """
+    Transformer function to unbold headings where the entire text is bold.
+    """
+    if isinstance(element, block.Heading):
+        # Check if the heading consists *only* of a single StrongEmphasis element
+        if len(element.children) == 1 and isinstance(element.children[0], inline.StrongEmphasis):
+            # Replace the heading's children with the children of the StrongEmphasis element
+            strong_emphasis_node = element.children[0]
+            # Type checker struggles here, but StrongEmphasis children should be Elements.
+            element.children = strong_emphasis_node.children  # pyright: ignore
+
+        # Handle the case where the heading is bold and italic (StrongEmphasis inside Emphasis or vice versa)
+        # ***text***  -> *text*
+        elif len(element.children) == 1 and isinstance(element.children[0], inline.Emphasis):
+            emphasis_node = element.children[0]
+            if len(emphasis_node.children) == 1 and isinstance(
+                emphasis_node.children[0], inline.StrongEmphasis
+            ):
+                strong_node = emphasis_node.children[0]
+                emphasis_node.children = strong_node.children
+
+
+def unbold_headings(doc: Document) -> None:
+    """
+    Find headings where the entire text is bold and remove the bold.
+
+    Modifies the Marko document tree in place using a general transformer.
+    Example: `## **My Heading**` -> `## My Heading`
+    """
+    transform_tree(doc, _unbold_heading_transformer)
+
+
+def doc_cleanups(doc: Document):
+    """
+    Apply (ideally quite safe) cleanups to the document.
+    """
+    unbold_headings(doc)

{flowmark-0.4.0 → flowmark-0.4.2}/src/flowmark/cli.py

@@ -55,6 +55,7 @@ class Options:
     width: int
     plaintext: bool
     semantic: bool
+    cleanups: bool
     inplace: bool
     nobackup: bool
     version: bool
@@ -98,6 +99,13 @@ def _parse_args(args: list[str] | None = None) -> Options:
         default=False,
         help="Enable semantic (sentence-based) line breaks (only applies to Markdown mode)",
     )
+    parser.add_argument(
+        "-c",
+        "--cleanups",
+        action="store_true",
+        default=False,
+        help="Enable (safe) cleanups for common issues (only applies to Markdown mode)",
+    )
     parser.add_argument(
         "-i", "--inplace", action="store_true", help="Edit the file in place (ignores --output)"
     )
@@ -129,6 +137,7 @@ def _parse_args(args: list[str] | None = None) -> Options:
         width=opts.width,
         plaintext=opts.plaintext,
         semantic=opts.semantic,
+        cleanups=opts.cleanups,
         inplace=opts.inplace,
         nobackup=opts.nobackup,
         version=opts.version,
@@ -177,6 +186,7 @@ def main(args: list[str] | None = None) -> int:
             text,
             width=options.width,
             semantic=options.semantic,
+            cleanups=options.cleanups,
             dedent_input=True,
         )