flowmark 0.3.1__tar.gz → 0.3.2__tar.gz

{flowmark-0.3.1 → flowmark-0.3.2}/.copier-answers.yml

@@ -1,9 +1,9 @@
 # Changes here will be overwritten by Copier. Do not edit manually.
-_commit: 1742e95
+_commit: v0.2.0
 _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_module: flowmark
 package_name: flowmark
-package_slug: flowmark

{flowmark-0.3.1 → flowmark-0.3.2}/.github/workflows/publish.yml

@@ -31,6 +31,9 @@ jobs:
       - name: Install all dependencies
         run: uv sync --all-extras --dev
 
+      - name: Run tests
+        run: uv run pytest
+        
       - name: Build package
         run: uv build
 

{flowmark-0.3.1 → flowmark-0.3.2}/.gitignore

@@ -1,7 +1,10 @@
 # Additions to standard GitHub .gitignore:
+*.bak
+*.orig
 tmp/
 trash/
-.kmd/
+attic/
+.kash/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

{flowmark-0.3.1 → flowmark-0.3.2}/Makefile

@@ -3,11 +3,11 @@
 
 .DEFAULT_GOAL := default
 
-.PHONY: default install_deps lint test build clean gen_test_docs
+.PHONY: default install lint test upgrade build clean gen_test_docs
 
-default: install_deps lint test
+default: install lint test
 
-install_deps:
+install:
 	uv sync --all-extras --dev
 
 lint:
@@ -16,6 +16,9 @@ lint:
 test:
 	uv run pytest
 
+upgrade:
+	uv sync --upgrade
+
 build:
 	uv build
 

{flowmark-0.3.1 → flowmark-0.3.2}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: flowmark
-Version: 0.3.1
+Version: 0.3.2
 Summary: Better line wrapping and formatting for plaintext and Markdown
-Project-URL: Repository, https://github.com//flowmark
+Project-URL: Repository, https://github.com/jlevy/flowmark
 Author-email: Joshua Levy <joshua@cal.berkeley.edu>
 License-Expression: MIT
 License-File: LICENSE
@@ -10,6 +10,7 @@ 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
@@ -17,6 +18,7 @@ Description-Content-Type: text/markdown
 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.
+after updating
 
 In addition, it adds **support for Markdown** and offers **Markdown auto-formatting and
 normalization** as a library or from the command line.
@@ -26,7 +28,10 @@ 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):
+The simplest way to use the tool is to use [uv](https://github.com/astral-sh/uv).
+Then run `uvx flowmark --help`.
+
+To install the command-line properly:
 
 ```shell
 uv tool install flowmark
@@ -44,7 +49,7 @@ Then
 flowmark --help
 ```
 
-To use as a library, use pip/poetry/uv to install
+To use as a library, use uv/poetry/pip to install
 [`flowmark`](https://pypi.org/project/flowmark/).
 
 ## Use in VSCode/Cursor
@@ -158,6 +163,7 @@ Markdown content. It can:
 
 - 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.
@@ -183,6 +189,8 @@ Command-line usage examples:
 For more details, see: https://github.com/jlevy/flowmark
 ```
 
+For instructions on publishing to PyPI, see [publishing.md](publishing.md).
+
 * * *
 
 *This project was built from

{flowmark-0.3.1 → flowmark-0.3.2}/README.md

@@ -3,6 +3,7 @@
 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.
+after updating
 
 In addition, it adds **support for Markdown** and offers **Markdown auto-formatting and
 normalization** as a library or from the command line.
@@ -12,7 +13,10 @@ 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):
+The simplest way to use the tool is to use [uv](https://github.com/astral-sh/uv).
+Then run `uvx flowmark --help`.
+
+To install the command-line properly:
 
 ```shell
 uv tool install flowmark
@@ -30,7 +34,7 @@ Then
 flowmark --help
 ```
 
-To use as a library, use pip/poetry/uv to install
+To use as a library, use uv/poetry/pip to install
 [`flowmark`](https://pypi.org/project/flowmark/).
 
 ## Use in VSCode/Cursor
@@ -144,6 +148,7 @@ Markdown content. It can:
 
 - 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.
@@ -169,6 +174,8 @@ Command-line usage examples:
 For more details, see: https://github.com/jlevy/flowmark
 ```
 
+For instructions on publishing to PyPI, see [publishing.md](publishing.md).
+
 * * *
 
 *This project was built from

flowmark-0.3.2/development.md

@@ -0,0 +1,89 @@
+# Development
+
+## Setting Up uv
+
+This project is set up to use [uv](https://docs.astral.sh/uv/) to manage Python and
+dependencies. First, be sure you
+[have uv installed](https://docs.astral.sh/uv/getting-started/installation/).
+
+Then [fork the jlevy/flowmark repo](https://github.com/jlevy/flowmark/fork) (having your
+own fork will make it easier to contribute) and
+[clone it](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
+
+## Basic Developer Workflows
+
+The `Makefile` simply offers shortcuts to `uv` commands for developer convenience.
+(For clarity, GitHub Actions don't use the Makefile and just call `uv` directly.)
+
+```shell
+# First, install all dependencies and set up your virtual environment.
+# This simply runs `uv sync --all-extras --dev` to install all packages,
+# including dev dependencies and optional dependencies.
+make install
+
+# Run uv sync, lint, and test:
+make
+
+# Build wheel:
+make build
+
+# Linting:
+make lint
+
+# Run tests:
+make test
+
+# Delete all the build artifacts:
+make clean
+
+# Upgrade dependencies to compatible versions:
+make upgrade
+
+# To run tests by hand:
+uv run pytest   # all tests
+uv run pytest -s src/module/some_file.py  # one test, showing outputs
+
+# Build and install current dev executables, to let you use your dev copies
+# as local tools:
+uv tool install --editable .
+
+# Dependency management directly with uv:
+# Add a new dependency:
+uv add package_name
+# Add a development dependency:
+uv add --dev package_name
+# Update to latest compatible versions (including dependencies on git repos):
+uv sync --upgrade
+# Update a specific package:
+uv lock --upgrade-package package_name
+# Update dependencies on a package:
+uv add package_name@latest
+
+# Run a shell within the Python environment:
+uv venv
+source .venv/bin/activate
+```
+
+See [uv docs](https://docs.astral.sh/uv/) for details.
+
+## IDE setup
+
+If you use VSCode or a fork like Cursor or Windsurf, you can install the following
+extensions:
+
+- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
+
+- [Based Pyright](https://marketplace.visualstudio.com/items?itemName=detachhead.basedpyright)
+  for type checking. Note that this extension works with non-Microsoft VSCode forks like
+  Cursor.
+
+## Documentation
+
+- [uv docs](https://docs.astral.sh/uv/)
+
+- [basedpyright docs](https://docs.basedpyright.com/latest/)
+
+* * *
+
+*This file was built with
+[simple-modern-uv](https://github.com/jlevy/simple-modern-uv).*

{flowmark-0.3.1 → flowmark-0.3.2}/devtools/lint.py

@@ -1,21 +1,21 @@
-# Update as needed.
-SRC_PATHS = ["src", "tests"]
-DOC_PATHS = ["README.md"]
-
-
 import subprocess
+
+from funlog import log_calls
 from rich import print as rprint
 
+# Update as needed.
+SRC_PATHS = ["src", "tests", "devtools"]
+DOC_PATHS = ["README.md"]
+
 
 def main():
     rprint()
 
     errcount = 0
-    errcount += _run(["codespell", "--write-changes", *SRC_PATHS, *DOC_PATHS])
-    errcount += _run(["usort", "format", *SRC_PATHS])
-    errcount += _run(["ruff", "check", "--fix", *SRC_PATHS])
-    errcount += _run(["black", *SRC_PATHS])
-    errcount += _run(["mypy", *SRC_PATHS])
+    errcount += run(["codespell", "--write-changes", *SRC_PATHS, *DOC_PATHS])
+    errcount += run(["ruff", "check", "--fix", *SRC_PATHS])
+    errcount += run(["ruff", "format", *SRC_PATHS])
+    errcount += run(["basedpyright", *SRC_PATHS])
 
     rprint()
 
@@ -28,7 +28,9 @@ def main():
     return errcount
 
 
-def _run(cmd: list[str]) -> int:
+@log_calls(level="warning", show_timing_only=True)
+def run(cmd: list[str]) -> int:
+    rprint()
     rprint(f"[bold green]❯ {' '.join(cmd)}[/bold green]")
     errcount = 0
     try:
@@ -36,7 +38,6 @@ def _run(cmd: list[str]) -> int:
     except subprocess.CalledProcessError as e:
         rprint(f"[bold red]Error: {e}[/bold red]")
         errcount = 1
-    rprint()
 
     return errcount
 

flowmark-0.3.2/publishing.md

@@ -0,0 +1,71 @@
+## Publishing Releases
+
+This is how to publish a Python package to [**PyPI**](https://pypi.org/) from GitHub
+Actions, when using the
+[**simple-modern-uv**](https://github.com/jlevy/simple-modern-uv) template.
+
+Thanks to [the dynamic versioning
+plugin](https://github.com/ninoseki/uv-dynamic-versioning/) and the
+[`publish.yml` workflow](https://github.com/jlevy/simple-modern-uv/blob/main/template/.github/workflows/publish.yml),
+you can simply create tagged releases (using standard format for the tag name, e.g.
+`v0.1.0`) on GitHub and the tag will trigger a release build, which then uploads it to
+PyPI.
+
+### How to Publish the First Time
+
+This part is a little confusing the first time.
+Here is the simplest way to do it.
+For the purposes of this example replace OWNER and PROJECT with the right values.
+
+1. **Get a PyPI account** at [pypi.org](https://pypi.org/) and sign in.
+
+2. **Pick a name for the project** that isn't already taken.
+
+   - Go to `https://pypi.org/project/PROJECT` to see if another project with that name
+     already exits.
+
+   - If needed, update your `pyproject.yml` with the correct name.
+
+3. **Authorize** your repository to publish to PyPI:
+
+   - Go to [the publishing settings page](https://pypi.org/manage/account/publishing/).
+
+   - Find "Trusted Publisher Management" and register your GitHub repo as a new
+     "pending" trusted publisher
+
+   - Enter the project name, repo owner, repo name, and `publish.yml` as the workflow
+     name. (You can leave the "environment name" field blank.)
+
+4. **Create a release** on GitHub:
+
+   - Commit code and make sure it's running correctly.
+
+   - Go to your GitHub project page, then click on Actions tab.
+
+   - Confirm all tests are passing in the last CI workflow.
+     (If you want, you can even publish this template when it's empty as just a stub
+     project, to try all this out.)
+
+   - Go to your GitHub project page, click on Releases.
+
+   - Fill in the tag and the release name.
+     Select to create a new tag, and pick a version.
+     A good option is `v0.1.0`. (It's wise to have it start with a `v`.)
+
+   - Submit to create the release.
+
+5. **Confirm it publishes to PyPI**
+
+   - Watch for the release workflow in the GitHub Actions tab.
+
+   - If it succeeds, you should see it appear at `https://pypi.org/project/PROJECT`.
+
+### How to Publish Subsequent Releases
+
+Just create a new release!
+Everything is the same as the last two steps above.
+
+* * *
+
+*This file was built with
+[simple-modern-uv](https://github.com/jlevy/simple-modern-uv).*

flowmark-0.3.2/pyproject.toml

@@ -0,0 +1,138 @@
+# ---- Project Info and Dependencies ----
+
+[project.urls]
+Repository = "https://github.com/jlevy/flowmark"
+# Homepage = "https://..."
+
+[project]
+name = "flowmark"
+description = "Better line wrapping and formatting for plaintext and Markdown"
+authors = [
+    { name="Joshua Levy", email="joshua@cal.berkeley.edu" },
+]
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10,<4.0"
+dynamic = ["version"]
+
+dependencies = [
+    "marko>=2.1.2",
+    "regex>=2024.11.6",
+    "strif>=2.0.0",
+    "typing-extensions>=4.12.2",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.3.5",
+    "ruff>=0.11.0",
+    "codespell>=2.4.1",
+    "rich>=13.9.4",
+    "basedpyright>=1.28.2",
+    "funlog>=0.2.0",
+]
+
+
+[project.scripts]
+# Add script entry points here.
+flowmark = "flowmark.cli:main"
+
+
+# ---- Build system ----
+
+# Dynamic versioning from:
+# https://github.com/ninoseki/uv-dynamic-versioning/
+
+[build-system]
+requires = ["hatchling", "uv-dynamic-versioning"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "uv-dynamic-versioning"
+# Note JSON schemas don't seem to be right for tool.hatch.version.source so
+# this may cause false warnings in IDEs.
+# https://github.com/ninoseki/uv-dynamic-versioning/issues/21
+
+[tool.uv-dynamic-versioning]
+vcs = "git"
+style = "pep440"
+bump = "true"
+
+# ---- Settings ----
+
+[tool.ruff]
+# Set as desired, typically 88 (black standard) or 100 (wide).
+line-length = 100
+
+[tool.ruff.lint]
+# See: https://docs.astral.sh/ruff/rules/
+select = [
+    # 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
+    "UP", # https://docs.astral.sh/ruff/rules/#pyupgrade-up
+    "B", # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+    "I", # https://docs.astral.sh/ruff/rules/#isort-i
+    # Other possibilities:
+    # "D" # https://docs.astral.sh/ruff/rules/#pydocstyle-d
+    # "Q" # https://docs.astral.sh/ruff/rules/#flake8-quotes-q
+    # "COM" # https://docs.astral.sh/ruff/rules/#flake8-commas-com
+    # "SIM", # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
+
+]
+ignore = [
+    "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/
+    # We use both ruff formatter and linter so some rules should always be disabled.
+    # See: https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+    "W191", # https://docs.astral.sh/ruff/rules/tab-indentation/
+    "E111", # https://docs.astral.sh/ruff/rules/indentation-with-invalid-multiple/
+    "E114", # https://docs.astral.sh/ruff/rules/indentation-with-invalid-multiple-comment/
+    "E117", # https://docs.astral.sh/ruff/rules/over-indented/
+    "D206", # https://docs.astral.sh/ruff/rules/docstring-tab-indentation/
+    "D300", # https://docs.astral.sh/ruff/rules/triple-single-quotes/
+    "Q000", # https://docs.astral.sh/ruff/rules/bad-quotes-inline-string/
+    "Q001", # https://docs.astral.sh/ruff/rules/bad-quotes-multiline-string/
+    "Q002", # https://docs.astral.sh/ruff/rules/bad-quotes-docstring/
+    "Q003", # https://docs.astral.sh/ruff/rules/avoidable-escaped-quote/
+    "COM812", # https://docs.astral.sh/ruff/rules/missing-trailing-comma/
+    "COM819", # https://docs.astral.sh/ruff/rules/prohibited-trailing-comma/
+    "ISC002", # https://docs.astral.sh/ruff/rules/multi-line-implicit-string-concatenation/
+]
+
+# 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:
+reportIgnoreCommentWithoutRule = false
+reportUnnecessaryTypeIgnoreComment = false
+# Typically noisy warnings, comment/uncomment as desired:
+reportMissingTypeStubs = false
+reportUnusedCallResult = false
+# reportMissingImports = false
+# reportUnnecessaryIsInstance = false
+# reportUnreachable = false
+reportAny = false
+reportExplicitAny = false
+reportUnusedParameter = false
+# reportUnknownVariableType = false
+# reportUnknownArgumentType = false
+
+[tool.codespell]
+# ignore-words-list = "foo,bar"
+skip = "tests/testdocs/*.md"
+
+[tool.pytest.ini_options]
+python_files = ["*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+testpaths = [
+    "src",
+    "tests",
+]
+norecursedirs = []
+filterwarnings = []

{flowmark-0.3.1 → flowmark-0.3.2}/src/flowmark/__init__.py

@@ -9,6 +9,7 @@ __all__ = (
     "Wrap",
 )
 
-from .markdown_filling import fill_markdown, line_wrap_by_sentence, line_wrap_to_width
-from .text_filling import fill_text, Wrap
+from .line_wrappers import line_wrap_by_sentence, line_wrap_to_width
+from .markdown_filling import fill_markdown
+from .text_filling import Wrap, fill_text
 from .text_wrapping import html_md_word_splitter, wrap_paragraph, wrap_paragraph_lines

{flowmark-0.3.1 → flowmark-0.3.2}/src/flowmark/cli.py

@@ -40,11 +40,10 @@ import argparse
 import importlib.metadata
 import sys
 from dataclasses import dataclass
-from typing import List, Optional
 
 from strif import atomic_output_file
 
-from flowmark import fill_markdown, fill_text, html_md_word_splitter, Wrap
+from flowmark import Wrap, fill_markdown, fill_text, html_md_word_splitter
 
 
 @dataclass
@@ -61,7 +60,7 @@ class Options:
     version: bool
 
 
-def _parse_args(args: Optional[List[str]] = None) -> Options:
+def _parse_args(args: list[str] | None = None) -> Options:
     """Parse command-line arguments for the flowmark tool."""
     # Use the module's docstring as the description
     module_doc = __doc__ or ""
@@ -136,7 +135,7 @@ def _parse_args(args: Optional[List[str]] = None) -> Options:
     )
 
 
-def main(args: Optional[List[str]] = None) -> int:
+def main(args: list[str] | None = None) -> int:
     """
     Main entry point for the flowmark CLI.
 
@@ -161,7 +160,7 @@ def main(args: Optional[List[str]] = None) -> int:
     if options.file == "-":
         text = sys.stdin.read()
     else:
-        with open(options.file, "r") as f:
+        with open(options.file) as f:
             text = f.read()
 
     if options.plaintext:

{flowmark-0.3.1 → flowmark-0.3.2}/src/flowmark/frontmatter.py

@@ -1,7 +1,4 @@
-from typing import Tuple
-
-
-def split_frontmatter(text: str) -> Tuple[str, str]:
+def split_frontmatter(text: str) -> tuple[str, str]:
     """
     Split a text document into frontmatter and content parts.
 

{flowmark-0.3.1 → flowmark-0.3.2}/src/flowmark/line_wrappers.py

@@ -1,10 +1,10 @@
-from typing import Callable, List, Protocol
+from collections.abc import Callable
+from typing import Protocol
 
 from flowmark.sentence_split_regex import split_sentences_regex
 from flowmark.text_filling import DEFAULT_WRAP_WIDTH
 from flowmark.text_wrapping import DEFAULT_LEN_FUNCTION, wrap_paragraph, wrap_paragraph_lines
 
-
 DEFAULT_MIN_LINE_LEN = 20
 """Default minimum line length for sentence breaking."""
 
@@ -20,10 +20,10 @@ class LineWrapper(Protocol):
 class SentenceSplitter(Protocol):
     """Takes a text string and returns a list of sentences."""
 
-    def __call__(self, text: str) -> List[str]: ...
+    def __call__(self, text: str) -> list[str]: ...
 
 
-def split_sentences_no_min_length(text: str) -> List[str]:
+def split_sentences_no_min_length(text: str) -> list[str]:
     return split_sentences_regex(text, min_length=0)
 
 
@@ -61,7 +61,7 @@ def line_wrap_by_sentence(
 
     def line_wrapper(text: str, initial_indent: str, subsequent_indent: str) -> str:
         text = text.replace("\n", " ")
-        lines: List[str] = []
+        lines: list[str] = []
         first_line = True
         length = len_fn
         initial_indent_len = len_fn(initial_indent)
@@ -69,7 +69,7 @@ def line_wrap_by_sentence(
 
         sentences = split_sentences(text)
 
-        for i, sentence in enumerate(sentences):
+        for sentence in sentences:
             current_column = initial_indent_len if first_line else subsequent_indent_len
             if len(lines) > 0 and length(lines[-1]) < min_line_len:
                 current_column += length(lines[-1])