mailfmt 0.1.0__tar.gz → 1.0.1__tar.gz

mailfmt-0.1.0/README.md → mailfmt-1.0.1/PKG-INFO

@@ -1,17 +1,29 @@
+Metadata-Version: 2.4
+Name: mailfmt
+Version: 1.0.1
+Summary: Heuristic plain text email formatter.
+Project-URL: Repository, https://git.sr.ht/~ficd/mailfmt
+Author-email: Daniel Fichtinger <daniel@ficd.ca>
+License-Expression: ISC
+License-File: LICENSE
+Keywords: cli,email,formatter
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
 <h1>Mail Format</h1>
 
 `mailfmt` is a simple plain text email formatter. It's designed to ensure
 consistent paragraph spacing while preserving markdown syntax, email headers,
 sign-offs, and signature blocks.
 
-By default, this script accepts its input on `stdin` and prints to `stdout`.
+By default, the command accepts its input on `stdin` and prints to `stdout`.
 This makes it well suited for use as a formatter with a text editor like Kakoune
-or Helix. It has no dependencies besides the standard Python interpreter, and
-was written and tested against Python 3.13.3.
+or Helix.
 
 <!--toc:start-->
 
 - [Features](#features)
+- [Installation](#installation)
 - [Usage](#usage)
 - [Output Example](#output-example)
 - [Markdown Safety](#markdown-safety)
@@ -37,6 +49,28 @@ was written and tested against Python 3.13.3.
   - Use case: piping the output to `pandoc` to write a `text/html` message. See
     [Markdown Safety](#markdown-safety).
 
+## Installation
+
+`mailfmt` is intended for use as a standaole tool. The package is available on
+PyPI as `mailfmt`. I recommend using [uv](https://github.com/astral-sh/uv) or
+`pipx` to install it so the `mailfmt` command is available on your path:
+
+```sh
+uv tool install mailfmt
+```
+
+Verify that the installation was successful:
+
+```sh
+mailfmt --help
+```
+
+The tool doesn't currently have any dependencies. Therefore, you can just
+download and execute the
+[mailfmt](https://git.sr.ht/~ficd/mailfmt/tree/main/item/mailfmt.py) script
+directly. However, dependencies may be introduced later, so I recommend
+installing with a Python package manager.
+
 ## Usage
 
 ```

mailfmt-0.1.0/PKG-INFO → mailfmt-1.0.1/README.md

@@ -1,26 +1,17 @@
-Metadata-Version: 2.4
-Name: mailfmt
-Version: 0.1.0
-Summary: Plain text email formatter
-Author-email: Daniel Fichtinger <daniel@ficd.ca>
-License-File: LICENSE
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-
 <h1>Mail Format</h1>
 
 `mailfmt` is a simple plain text email formatter. It's designed to ensure
 consistent paragraph spacing while preserving markdown syntax, email headers,
 sign-offs, and signature blocks.
 
-By default, this script accepts its input on `stdin` and prints to `stdout`.
+By default, the command accepts its input on `stdin` and prints to `stdout`.
 This makes it well suited for use as a formatter with a text editor like Kakoune
-or Helix. It has no dependencies besides the standard Python interpreter, and
-was written and tested against Python 3.13.3.
+or Helix.
 
 <!--toc:start-->
 
 - [Features](#features)
+- [Installation](#installation)
 - [Usage](#usage)
 - [Output Example](#output-example)
 - [Markdown Safety](#markdown-safety)
@@ -46,6 +37,28 @@ was written and tested against Python 3.13.3.
   - Use case: piping the output to `pandoc` to write a `text/html` message. See
     [Markdown Safety](#markdown-safety).
 
+## Installation
+
+`mailfmt` is intended for use as a standaole tool. The package is available on
+PyPI as `mailfmt`. I recommend using [uv](https://github.com/astral-sh/uv) or
+`pipx` to install it so the `mailfmt` command is available on your path:
+
+```sh
+uv tool install mailfmt
+```
+
+Verify that the installation was successful:
+
+```sh
+mailfmt --help
+```
+
+The tool doesn't currently have any dependencies. Therefore, you can just
+download and execute the
+[mailfmt](https://git.sr.ht/~ficd/mailfmt/tree/main/item/mailfmt.py) script
+directly. However, dependencies may be introduced later, so I recommend
+installing with a Python package manager.
+
 ## Usage
 
 ```

mailfmt-1.0.1/justfile

@@ -0,0 +1,21 @@
+clean:
+    #!/bin/sh
+    if [ ! -d "dist" ] && [ ! -d "__pycache__" ]; then
+        echo "Nothing to clean."
+        exit 0
+    fi
+    if [ -d "dist" ]; then
+        echo "Removing dist/"
+        rm -r dist/
+    fi
+    if [ -d "__pycache__" ]; then
+        echo "Removing __pycache__/"
+        rm -r "__pycache__"
+    fi
+publish:
+    #!/bin/sh
+    just clean
+    uv build
+    export UV_PUBLISH_TOKEN="$(pass show pypi)"
+    uv publish
+

{mailfmt-0.1.0 → mailfmt-1.0.1}/mailfmt.py

@@ -84,11 +84,12 @@ def main() -> None:
             return False
 
     parser = argparse.ArgumentParser(
-        description='Formatter for plain text email.\n"--no-*" options are NOT passed by default.',
+        description="Heuristic formatter for plain text email. Preserves markup, signoffs, and signature blocks.",
         epilog="""
-Author : Daniel Fichtinger
-License: ISC
-Contact: daniel@ficd.ca
+Author    : Daniel Fichtinger
+Repository: https://git.sr.ht/~ficd/mailfmt
+License   : ISC
+Contact   : daniel@ficd.ca
         """,
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )

{mailfmt-0.1.0 → mailfmt-1.0.1}/pyproject.toml

@@ -1,13 +1,19 @@
 [project]
 name = "mailfmt"
-version = "0.1.0"
-description = "Plain text email formatter"
+version = "1.0.1"
+description = "Heuristic plain text email formatter."
 readme = "README.md"
 authors = [
     { name = "Daniel Fichtinger", email = "daniel@ficd.ca" }
 ]
 requires-python = ">=3.11"
 dependencies = []
+license = "ISC"
+license-files = ["LICENSE"]
+keywords = ["email", "formatter", "cli"]
+
+[project.urls]
+Repository = "https://git.sr.ht/~ficd/mailfmt"
 
 [project.scripts]
 mailfmt = "mailfmt:main"

{mailfmt-0.1.0 → mailfmt-1.0.1}/uv.lock

@@ -4,5 +4,5 @@ requires-python = ">=3.11"
 
 [[package]]
 name = "mailfmt"
-version = "0.1.0"
+version = "1.0.1"
 source = { editable = "." }