diff options
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | README.md | 22 | ||||
| -rw-r--r-- | pyproject.toml | 2 | ||||
| -rw-r--r-- | src/formbox.py (renamed from formbox.py) | 0 |
4 files changed, 24 insertions, 1 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..849ddff --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +dist/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..77fe625 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# formbox + +This tiny script formats an [mbox] as HTML or XML. It is intended +for rendering email replies on websites and their [RSS] feed. + +## Prerequisites + +This Python package depends on [bleach] for HTML sanitising +and [markdown] for, well, rendering Markdown to HTML. It is, however, +not designed to work with HTML emails with all those CSS and Java scripts. + +## Copying + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published +by the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +[mbox]: https://en.wikipedia.org/wiki/Mbox +[RSS]: https://www.rssboard.org +[bleach]: https://bleach.readthedocs.io +[markdown]: https://python-markdown.github.io diff --git a/pyproject.toml b/pyproject.toml index 9256938..6faa001 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,7 +13,7 @@ authors = [ { name = "Nguyễn Gia Phong", email = "mcsinyx@disroot.org" } ] maintainers = [ { name = "Nguyễn Gia Phong", email = "mcsinyx@disroot.org" } ] keywords = [ "email", "format", "html", "mbox", "template", "xml" ] classifiers = [ - "Development Status :: 5 - Production/Stable", + "Development Status :: 3 - Alpha", "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", "Operating System :: OS Independent", "Programming Language :: Python", diff --git a/formbox.py b/src/formbox.py index cdb0c76..cdb0c76 100644 --- a/formbox.py +++ b/src/formbox.py |