mailfmt 0.1.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

{mailfmt-0.1.0.dist-info → mailfmt-1.0.1.dist-info}/METADATA

@@ -1,9 +1,12 @@
 Metadata-Version: 2.4
 Name: mailfmt
-Version: 0.1.0
-Summary: Plain text email formatter
+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
 
@@ -13,14 +16,14 @@ Description-Content-Type: text/markdown
 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 +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-1.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+mailfmt.py,sha256=Wl1maUKnbhwVdglHZxuTt4YApYP5lv3FUUJ0gWOrz_M,6568
+mailfmt-1.0.1.dist-info/METADATA,sha256=blXENNntFVAEvOOGGRsBaSf19ptrD9kVK1HGsvYW_9c,6272
+mailfmt-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mailfmt-1.0.1.dist-info/entry_points.txt,sha256=eFkLVHtmLEdRnOOzT4d2pAy7mBkjESW_8VQgUfAWvk4,41
+mailfmt-1.0.1.dist-info/licenses/LICENSE,sha256=M8EhEEXHuRQsNgdRFtF2Ty6P62p8vgDanib1C-Zqkqc,749
+mailfmt-1.0.1.dist-info/RECORD,,

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.dist-info/RECORD

@@ -1,6 +0,0 @@
-mailfmt.py,sha256=auV0gcx7smsNhjbjdL8yNNDVEEidGMwJMB4AsUyBwbk,6500
-mailfmt-0.1.0.dist-info/METADATA,sha256=oJkZ8gCdpMFJOyLXO7BZHYfVoL2x2zZlpRwhSo6fjLg,5587
-mailfmt-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mailfmt-0.1.0.dist-info/entry_points.txt,sha256=eFkLVHtmLEdRnOOzT4d2pAy7mBkjESW_8VQgUfAWvk4,41
-mailfmt-0.1.0.dist-info/licenses/LICENSE,sha256=M8EhEEXHuRQsNgdRFtF2Ty6P62p8vgDanib1C-Zqkqc,749
-mailfmt-0.1.0.dist-info/RECORD,,