From 0cad9c91c3825821f664abbe5167a3b3e801f443 Mon Sep 17 00:00:00 2001 From: Daniel Fichtinger Date: Wed, 4 Jun 2025 12:34:00 -0400 Subject: [PATCH] packaged for pypi --- .gitignore | 177 ++++++++++++++++++++++++++++++++++++++++++ .python-version | 1 + install.sh | 5 -- mailfmt => mailfmt.py | 123 +++++++++++++++-------------- pyproject.toml | 17 ++++ uninstall.sh | 4 - uv.lock | 8 ++ 7 files changed, 264 insertions(+), 71 deletions(-) create mode 100644 .gitignore create mode 100644 .python-version delete mode 100755 install.sh rename mailfmt => mailfmt.py (71%) create mode 100644 pyproject.toml delete mode 100755 uninstall.sh create mode 100644 uv.lock diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..729a846 --- /dev/null +++ b/.gitignore @@ -0,0 +1,177 @@ +typings/ + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# UV +# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +#uv.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/latest/usage/project/#working-with-version-control +.pdm.toml +.pdm-python +.pdm-build/ + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ + +# Ruff stuff: +.ruff_cache/ + +# PyPI configuration file +.pypirc + diff --git a/.python-version b/.python-version new file mode 100644 index 0000000..2c07333 --- /dev/null +++ b/.python-version @@ -0,0 +1 @@ +3.11 diff --git a/install.sh b/install.sh deleted file mode 100755 index f72f4c4..0000000 --- a/install.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/bin/sh - -SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" -sudo cp "$SCRIPT_DIR/mailfmt" /usr/bin/mailfmt -echo "mailfmt has been installed to /usr/bin/mailfmt." diff --git a/mailfmt b/mailfmt.py similarity index 71% rename from mailfmt rename to mailfmt.py index a12e4c7..e8d1f7a 100755 --- a/mailfmt +++ b/mailfmt.py @@ -16,78 +16,73 @@ import sys import re import argparse -paragraph: list[str] = [] -skipping = False -squash = True -prev_is_parbreak = False -out_stream = sys.stdout -reflow = True -width = 74 -break_long_words = False -replace_whitespace = True -markdown_safe = False -in_signoff = False -in_signature = False +def main() -> None: + paragraph: list[str] = [] + skipping = False + squash = True + prev_is_parbreak = False + out_stream = sys.stdout + reflow = True + width = 74 + break_long_words = False + replace_whitespace = True + markdown_safe = False + in_signoff = False + in_signature = False -def pprint(string: str): - if markdown_safe and (in_signoff or in_signature) and string: - string += " \\" - if not squash: - print(string, file=out_stream) - else: - parbreak = not string - global prev_is_parbreak - if skipping or not (parbreak and prev_is_parbreak): + def pprint(string: str): + if markdown_safe and (in_signoff or in_signature) and string: + string += " \\" + if not squash: print(string, file=out_stream) - prev_is_parbreak = parbreak - - -def wrap(text: str): - return textwrap.wrap( - text, - width=width, - break_long_words=break_long_words, - replace_whitespace=replace_whitespace, - ) - - -def flush_paragraph(): - if paragraph: - if reflow: - joined = " ".join(paragraph) - wrapped = wrap(joined) - pprint("\n".join(wrapped)) else: - for line in paragraph: - for wrapped_line in wrap(line): - pprint(wrapped_line) - paragraph.clear() + parbreak = not string + nonlocal prev_is_parbreak + if skipping or not (parbreak and prev_is_parbreak): + print(string, file=out_stream) + prev_is_parbreak = parbreak + def wrap(text: str): + return textwrap.wrap( + text, + width=width, + break_long_words=break_long_words, + replace_whitespace=replace_whitespace, + ) -signoff_cache: str = "" + def flush_paragraph(): + if paragraph: + if reflow: + joined = " ".join(paragraph) + wrapped = wrap(joined) + pprint("\n".join(wrapped)) + else: + for line in paragraph: + for wrapped_line in wrap(line): + pprint(wrapped_line) + paragraph.clear() + signoff_cache: str = "" -def check_signoff(line: str) -> bool: - if not line: - return False - words = line.split() - n = len(words) - # first potential signoff line - if not signoff_cache and 1 <= n <= 5 and line[-1] == ",": - return True - # second potential line - elif signoff_cache and 1 <= n <= 5 and line[-1].isalpha(): - for w in words: - if not w[0].isupper(): - return False - return True - else: - return False + def check_signoff(line: str) -> bool: + if not line: + return False + words = line.split() + n = len(words) + # first potential signoff line + if not signoff_cache and 1 <= n <= 5 and line[-1] == ",": + return True + # second potential line + elif signoff_cache and 1 <= n <= 5 and line[-1].isalpha(): + for w in words: + if not w[0].isupper(): + return False + return True + else: + return False - -if __name__ == "__main__": parser = argparse.ArgumentParser( description='Formatter for plain text email.\n"--no-*" options are NOT passed by default.', epilog=""" @@ -228,4 +223,8 @@ Contact: daniel@ficd.ca if out_stream is not None: out_stream.close() + +if __name__ == "__main__": + main() + # pyright: basic diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..d8dedf2 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,17 @@ +[project] +name = "mailfmt" +version = "0.1.0" +description = "Add your description here" +readme = "README.md" +authors = [ + { name = "Daniel Fichtinger", email = "daniel@ficd.ca" } +] +requires-python = ">=3.11" +dependencies = [] + +[project.scripts] +mailfmt = "mailfmt:main" + +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" diff --git a/uninstall.sh b/uninstall.sh deleted file mode 100755 index e995aa0..0000000 --- a/uninstall.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh - -sudo rm /usr/bin/mailfmt -echo "mailfmt has been uninstalled." diff --git a/uv.lock b/uv.lock new file mode 100644 index 0000000..6688ee9 --- /dev/null +++ b/uv.lock @@ -0,0 +1,8 @@ +version = 1 +revision = 2 +requires-python = ">=3.11" + +[[package]] +name = "mailfmt" +version = "0.1.0" +source = { editable = "." }