mailfmt 0.1.0__tar.gz → 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. mailfmt-0.1.0/README.md → mailfmt-1.0.0/PKG-INFO +38 -3
  2. mailfmt-0.1.0/PKG-INFO → mailfmt-1.0.0/README.md +25 -12
  3. {mailfmt-0.1.0 → mailfmt-1.0.0}/pyproject.toml +8 -1
  4. {mailfmt-0.1.0 → mailfmt-1.0.0}/.gitignore +0 -0
  5. {mailfmt-0.1.0 → mailfmt-1.0.0}/.python-version +0 -0
  6. {mailfmt-0.1.0 → mailfmt-1.0.0}/LICENSE +0 -0
  7. {mailfmt-0.1.0 → mailfmt-1.0.0}/mailfmt.py +0 -0
  8. {mailfmt-0.1.0 → mailfmt-1.0.0}/uv.lock +0 -0
mailfmt-0.1.0/README.md → mailfmt-1.0.0/PKG-INFO RENAMED
@@ -1,17 +1,30 @@
1
+ Metadata-Version: 2.4
2
+ Name: mailfmt
3
+ Version: 1.0.0
4
+ Summary: Plain text email formatter
5
+ Project-URL: Repository, https://git.sr.ht/~ficd/mailfmt
6
+ Project-URL: Homepage, https://sr.ht/~ficd/mailfmt
7
+ Author-email: Daniel Fichtinger <daniel@ficd.ca>
8
+ License-Expression: ISC
9
+ License-File: LICENSE
10
+ Keywords: email,formatter
11
+ Requires-Python: >=3.11
12
+ Description-Content-Type: text/markdown
13
+
1
14
  <h1>Mail Format</h1>
2
15
 
3
16
  `mailfmt` is a simple plain text email formatter. It's designed to ensure
4
17
  consistent paragraph spacing while preserving markdown syntax, email headers,
5
18
  sign-offs, and signature blocks.
6
19
 
7
- By default, this script accepts its input on `stdin` and prints to `stdout`.
20
+ By default, the command accepts its input on `stdin` and prints to `stdout`.
8
21
  This makes it well suited for use as a formatter with a text editor like Kakoune
9
- or Helix. It has no dependencies besides the standard Python interpreter, and
10
- was written and tested against Python 3.13.3.
22
+ or Helix.
11
23
 
12
24
  <!--toc:start-->
13
25
 
14
26
  - [Features](#features)
27
+ - [Installation](#installation)
15
28
  - [Usage](#usage)
16
29
  - [Output Example](#output-example)
17
30
  - [Markdown Safety](#markdown-safety)
@@ -37,6 +50,28 @@ was written and tested against Python 3.13.3.
37
50
  - Use case: piping the output to `pandoc` to write a `text/html` message. See
38
51
  [Markdown Safety](#markdown-safety).
39
52
 
53
+ ## Installation
54
+
55
+ `mailfmt` is intended for use as a standaole tool. The package is available on
56
+ PyPI as `mailfmt`. I recommend using [uv](https://github.com/astral-sh/uv) or
57
+ `pipx` to install it so the `mailfmt` command is available on your path:
58
+
59
+ ```sh
60
+ uv tool install mailfmt
61
+ ```
62
+
63
+ Verify that the installation was successful:
64
+
65
+ ```sh
66
+ mailfmt --help
67
+ ```
68
+
69
+ The tool doesn't currently have any dependencies. Therefore, you can just
70
+ download and execute the
71
+ [mailfmt](https://git.sr.ht/~ficd/mailfmt/tree/main/item/mailfmt.py) script
72
+ directly. However, dependencies may be introduced later, so I recommend
73
+ installing with a Python package manager.
74
+
40
75
  ## Usage
41
76
 
42
77
  ```
mailfmt-0.1.0/PKG-INFO → mailfmt-1.0.0/README.md RENAMED
@@ -1,26 +1,17 @@
1
- Metadata-Version: 2.4
2
- Name: mailfmt
3
- Version: 0.1.0
4
- Summary: Plain text email formatter
5
- Author-email: Daniel Fichtinger <daniel@ficd.ca>
6
- License-File: LICENSE
7
- Requires-Python: >=3.11
8
- Description-Content-Type: text/markdown
9
-
10
1
  <h1>Mail Format</h1>
11
2
 
12
3
  `mailfmt` is a simple plain text email formatter. It's designed to ensure
13
4
  consistent paragraph spacing while preserving markdown syntax, email headers,
14
5
  sign-offs, and signature blocks.
15
6
 
16
- By default, this script accepts its input on `stdin` and prints to `stdout`.
7
+ By default, the command accepts its input on `stdin` and prints to `stdout`.
17
8
  This makes it well suited for use as a formatter with a text editor like Kakoune
18
- or Helix. It has no dependencies besides the standard Python interpreter, and
19
- was written and tested against Python 3.13.3.
9
+ or Helix.
20
10
 
21
11
  <!--toc:start-->
22
12
 
23
13
  - [Features](#features)
14
+ - [Installation](#installation)
24
15
  - [Usage](#usage)
25
16
  - [Output Example](#output-example)
26
17
  - [Markdown Safety](#markdown-safety)
@@ -46,6 +37,28 @@ was written and tested against Python 3.13.3.
46
37
  - Use case: piping the output to `pandoc` to write a `text/html` message. See
47
38
  [Markdown Safety](#markdown-safety).
48
39
 
40
+ ## Installation
41
+
42
+ `mailfmt` is intended for use as a standaole tool. The package is available on
43
+ PyPI as `mailfmt`. I recommend using [uv](https://github.com/astral-sh/uv) or
44
+ `pipx` to install it so the `mailfmt` command is available on your path:
45
+
46
+ ```sh
47
+ uv tool install mailfmt
48
+ ```
49
+
50
+ Verify that the installation was successful:
51
+
52
+ ```sh
53
+ mailfmt --help
54
+ ```
55
+
56
+ The tool doesn't currently have any dependencies. Therefore, you can just
57
+ download and execute the
58
+ [mailfmt](https://git.sr.ht/~ficd/mailfmt/tree/main/item/mailfmt.py) script
59
+ directly. However, dependencies may be introduced later, so I recommend
60
+ installing with a Python package manager.
61
+
49
62
  ## Usage
50
63
 
51
64
  ```
{mailfmt-0.1.0 → mailfmt-1.0.0}/pyproject.toml RENAMED
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "mailfmt"
3
- version = "0.1.0"
3
+ version = "1.0.0"
4
4
  description = "Plain text email formatter"
5
5
  readme = "README.md"
6
6
  authors = [
@@ -8,6 +8,13 @@ authors = [
8
8
  ]
9
9
  requires-python = ">=3.11"
10
10
  dependencies = []
11
+ license = "ISC"
12
+ license-files = ["LICENSE"]
13
+ keywords = ["email", "formatter"]
14
+
15
+ [project.urls]
16
+ Repository = "https://git.sr.ht/~ficd/mailfmt"
17
+ Homepage = "https://sr.ht/~ficd/mailfmt"
11
18
 
12
19
  [project.scripts]
13
20
  mailfmt = "mailfmt:main"
{mailfmt-0.1.0 → mailfmt-1.0.0}/.gitignore RENAMED
File without changes
{mailfmt-0.1.0 → mailfmt-1.0.0}/.python-version RENAMED
File without changes
{mailfmt-0.1.0 → mailfmt-1.0.0}/LICENSE RENAMED
File without changes
{mailfmt-0.1.0 → mailfmt-1.0.0}/mailfmt.py RENAMED
File without changes
{mailfmt-0.1.0 → mailfmt-1.0.0}/uv.lock RENAMED
File without changes