create pyproject and new entrypoint

Author: Sven Siegmund

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Sven Siegmud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

changelog.d/changelog_template.jinja

@@ -0,0 +1,15 @@
+{% if sections[""] %}
+{% for category, val in definitions.items() if category in sections[""] %}
+
+### {{ definitions[category]['name'] }}
+
+{% for text, values in sections[""][category].items() %}
+- {{ text }} {{ values|join(', ') }}
+{% endfor %}
+
+{% endfor %}
+{% else %}
+No significant changes.
+
+
+{% endif %}

pyproject.toml

@@ -0,0 +1,144 @@
+[build-system]
+requires = [
+    "hatchling",
+    "hatch-semver"
+]
+build-backend = "hatchling.build"
+
+[project]
+name = "rtfparse"
+description = "Tool to parse Microsoft Rich Text Format (RTF)"
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+  { name = "Sven Siegmund", email = "[email protected]" },
+]
+classifiers = [
+    #"Development Status :: 3 - Alpha",
+    #"Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Environment :: Console",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Utilities",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Operating System :: OS Independent",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: MacOS :: MacOS X",
+]
+keywords = [
+    "rtf",
+    "parse",
+]
+dependencies = [
+    "argcomplete",
+    "extract-msg",
+    "compressed_rtf",
+    "provide_dir",
+]
+dynamic = ["version"]
+
+[project.license]
+file = "LICENSE.txt"
+
+[project.urls]
+Documentation = "https://github.com/fleetingbytes/rtfparse#readme"
+Issues = "https://github.com/fleetingbytes/rtfparse/issues"
+Source = "https://github.com/fleetingbytes/rtfparse"
+
+[project.scripts]
+rtfparse = "rtfparse:main"
+
+[tool.hatch.version]
+path = "src/rtfparse/__about__.py"
+validate-bump = true
+scheme = "semver"
+
+[tool.hatch.envs.default]
+dependencies = [
+  "pytest-cov",
+]
+[tool.hatch.envs.default.scripts]
+cov = "pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=src/rtfparse --cov=tests {args}"
+no-cov = "cov --no-cov {args}"
+
+[tool.hatch.envs.style]
+dependencies = [
+    "black",
+    "isort",
+]
+
+[tool.hatch.envs.style.scripts]
+fmt = [
+    "isort .",
+    "black .",
+]
+
+[tool.hatch.envs.tc]
+dependencies = [
+    "towncrier",
+]
+
+[tool.hatch.envs.tc.scripts]
+draft = "towncrier build --draft"
+build = "towncrier build --yes"
+
+[tool.hatch.envs.docs]
+dependencies = [
+    "pdoc3"
+]
+
+[[tool.hatch.envs.test.matrix]]
+python = ["311"]
+
+[tool.coverage.run]
+branch = true
+parallel = true
+omit = [
+  #"src/rtfparse/__about__.py",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]
+
+[tool.black]
+    line-length = 102
+
+[tool.isort]
+    line_length = 102
+
+[tool.towncrier]
+name = "rtfparse"
+package = "rtfparse"
+package_dir = "src"
+directory = "changelog.d"
+filename = "CHANGELOG.md"
+start_string = "<!-- towncrier release notes start -->\n"
+underlines = ["", "", ""]
+template = "changelog.d/changelog_template.jinja"
+#title_format = "## [{version}](https://github.com/fleetingbytes/rtfparse/{version}) - {project_date}"
+title_format = "## {version} ({project_date})"
+issue_format = "[#{issue}](https://github.com/fleetingbytes/rtfparse/issues/{issue})"
+orphan_prefix = "+"
+
+[tool.towncrier.fragment.doc]
+name = "Documentation"
+
+[tool.towncrier.fragment.feature]
+name = "New Features"
+
+[tool.towncrier.fragment.improved]
+name = "Improvements"
+
+[tool.towncrier.fragment.fixed]
+name = "Bugfixes"
+
+[tool.towncrier.fragment.unimportant]
+name = "Development Details"

setup.py

@@ -0,0 +1,4 @@
+#!/usr/bin/env python
+
+
+__version__ = "0.8.0-rc1"

src/rtfparse/__about__.py

@@ -1,18 +1,10 @@
 #!/usr/bin/env python
 
 
-"""
-Parser of Microsoft RTF Format
-"""
-
-
-from rtfparse import version
-
-
-__author__ = "Sven Siegmund"
-__author_email__ = "[email protected]"
-__date__ = "2020-01-05"
-__version__ = version.version
-
+from rtfparse.cli import main
 
+# Towncrier needs version
+from rtfparse.__about__ import __version__
 
+if __name__ == "__main__":
+    main()

src/rtfparse/__init__.py

@@ -0,0 +1,79 @@
+#!/usr/bin/env python
+
+import logging
+import logging.config
+from pathlib import Path
+from provide_dir import provide_dir
+from rtfparse import logging_conf
+
+
+def setup_logger(directory: Path) -> logging.Logger:
+    """
+    Returns a logger and a path to directory where the logs are saved
+    """
+    try:
+        provide_dir(directory)
+        logger_config = logging_conf.create_dict_config(
+            directory, "debug.log", "info.log", "errors.log"
+        )
+    except FileExistsError:
+        logger.error(
+            f"Failed to create the directory `{str(directory)}` because it already exists as a file."
+        )
+        logger.error(f"Please create the directory `{str(directory)}`")
+    finally:
+        logging.config.dictConfig(logger_config)
+        logger = logging.getLogger(__name__)
+    return logger
+
+
+logger = setup_logger(Path.home() / "rtfparse")
+
+
+def argument_parser() -> argparse.ArgumentParser:
+    """
+    Creates an argument parser for command line arguments
+    """
+    parser = argparse.ArgumentParser(description="RTF parser")
+    parser.add_argument(
+        "-v", "--version", action="store_true", help="print out rtfparse version and exit"
+    )
+    parser.add_argument("--autoconfig", action="store_true", help="Configure rtfparse automatically")
+    parser.add_argument(
+        "-f", "--file", action="store", metavar="PATH", type=Path, help="path to the rtf file"
+    )
+    parser.add_argument(
+        "-m",
+        "--msg",
+        action="store",
+        metavar="PATH",
+        type=Path,
+        help="Parse RTF from MS Outlook's .msg file",
+    )
+    parser.add_argument(
+        "-d", "--de-encapsulate-html", action="store_true", help="De-encapsulate HTML from RTF"
+    )
+    parser.add_argument(
+        "-i", "--embed-img", action="store_true", help="Embed images from email to HTML"
+    )
+    return parser
+
+
+def run(cli_args: argparse.Namespace) -> None:
+    logger.info("Program runs")
+
+
+def main(version) -> None:
+    """
+    Entry point for any component start from the commmand line
+    """
+    logger.debug(f"{utils.program_name} started")
+    parser = argument_parser()
+    argcomplete.autocomplete(parser)
+    cli_args = parser.parse_args()
+    logger.debug(f"Parsed arguments: {cli_args}")
+    try:
+        run(cli_args)
+    except Exception as err:
+        logger.exception(f"Uncaught exception {repr(err)} occurred.")
+    logger.debug(f"{utils.program_name} ended")