RepoAuditor 0.1.0__py3-none-any.whl

BuildBinary.py

@@ -0,0 +1,104 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# ----------------------------------------------------------------------
+"""Builds the binary for this project."""
+
+import datetime
+import importlib
+import textwrap
+
+from functools import cache
+from pathlib import Path
+
+from cx_Freeze import setup, Executable
+from dbrownell_Common import PathEx
+
+
+# ----------------------------------------------------------------------
+@cache
+def _GetName() -> str:
+    return "RepoAuditor"
+
+
+# ----------------------------------------------------------------------
+@cache
+def _GetVersionAndDocstring() -> tuple[str, str]:
+    mod = importlib.import_module(_GetName())
+    return mod.__version__, mod.__doc__ or ""
+
+
+# ----------------------------------------------------------------------
+@cache
+def _GetEntryPoint() -> Path:
+    return PathEx.EnsureFile(Path(__file__).parent / _GetName() / "EntryPoint.py")
+
+
+# ----------------------------------------------------------------------
+@cache
+def _GetCopyright() -> str:
+    initial_year = 2024
+    current_year = datetime.datetime.now().year
+
+    if current_year == initial_year:
+        year_suffix = ""
+    elif current_year // 100 != initial_year // 100:
+        year_suffix = str(current_year)
+    else:
+        year_suffix = "-{}".format(current_year % 100)
+
+    return textwrap.dedent(
+        f"""\
+        Copyright (c) {initial_year}{year_suffix} Scientific Software Engineering Center at Georgia Tech
+
+        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.
+        """,
+    )
+
+
+# ----------------------------------------------------------------------
+setup(
+    name=_GetName(),
+    version=_GetVersionAndDocstring()[0],
+    description=_GetVersionAndDocstring()[1],
+    executables=[
+        Executable(
+            _GetEntryPoint(),
+            base="console",
+            copyright=_GetCopyright(),
+            # icon=<icon_filename>,
+            target_name=_GetName(),
+            # trademarks=<trademarks>,
+        ),
+    ],
+    options={
+        "build_exe": {
+            "excludes": [
+                "tcl",
+                "tkinter",
+            ],
+            "no_compress": False,
+            "optimize": 0,
+            # "packages": [],
+            # "include_files": [],
+        },
+    },
+)

RepoAuditor/EntryPoint.py

@@ -0,0 +1,92 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# ----------------------------------------------------------------------
+"""This file serves as an example of how to create scripts that can be invoked from the command line once the package is installed."""
+
+import sys
+
+import typer
+
+from typer.core import TyperGroup  # type: ignore [import-untyped]
+
+from RepoAuditor import Math, __version__
+
+
+# ----------------------------------------------------------------------
+class NaturalOrderGrouper(TyperGroup):
+    # pylint: disable=missing-class-docstring
+    # ----------------------------------------------------------------------
+    def list_commands(self, *args, **kwargs):  # pylint: disable=unused-argument
+        return self.commands.keys()
+
+
+# ----------------------------------------------------------------------
+app = typer.Typer(
+    cls=NaturalOrderGrouper,
+    help=__doc__,
+    no_args_is_help=True,
+    pretty_exceptions_show_locals=False,
+    pretty_exceptions_enable=False,
+)
+
+
+# ----------------------------------------------------------------------
+@app.command("Add")
+def Add(
+    x: int,
+    y: int,
+) -> None:
+    """Adds 2 values."""
+
+    sys.stdout.write(str(Math.Add(x, y)))
+
+
+# ----------------------------------------------------------------------
+@app.command("Sub")
+def Sub(
+    x: int,
+    y: int,
+) -> None:
+    """Subtracts 2 values."""
+
+    sys.stdout.write(str(Math.Sub(x, y)))
+
+
+# ----------------------------------------------------------------------
+@app.command("Mult")
+def Mult(
+    x: int,
+    y: int,
+) -> None:
+    """Multiplies 2 values."""
+
+    sys.stdout.write(str(Math.Mult(x, y)))
+
+
+# ----------------------------------------------------------------------
+@app.command("Div")
+def Div(
+    x: int,
+    y: int,
+) -> None:
+    """Divides 1 value by another."""
+
+    sys.stdout.write(str(Math.Div(x, y)))
+
+
+# ----------------------------------------------------------------------
+@app.command("Version")
+def Version() -> None:
+    """Prints the version of the package."""
+
+    sys.stdout.write(__version__)
+
+
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+if __name__ == "__main__":
+    app()  # pragma: no cover

RepoAuditor/Math.py

@@ -0,0 +1,27 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# ----------------------------------------------------------------------
+"""Basic math functions. This file illustrates how to create a python package that contains functions that can be invoked by other python code."""
+
+
+# ----------------------------------------------------------------------
+def Add(x, y):
+    return x + y
+
+
+# ----------------------------------------------------------------------
+def Sub(x, y):
+    return x - y
+
+
+# ----------------------------------------------------------------------
+def Mult(x, y):
+    return x * y
+
+
+# ----------------------------------------------------------------------
+def Div(x, y):
+    return x / y

RepoAuditor/__init__.py

@@ -0,0 +1,14 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+# |  Distributed under the MIT License.
+# |
+# ----------------------------------------------------------------------
+# pylint: disable=missing-module-docstring,invalid-name
+
+# Note that this value will be overwritten by calls to `python ../../Build.py update_version` based
+# on changes observed in the git repository. The default value below will be used until the value
+# here is explicitly updated as part of a commit.
+__version__ = "0.1.0"
+
+from .Math import Add, Sub, Mult, Div

RepoAuditor-0.1.0.dist-info/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) 2024 Scientific Software Engineering Center at Georgia Tech
+
+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.

RepoAuditor-0.1.0.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.1
+Name: RepoAuditor
+Version: 0.1.0
+Summary: Audits repositories for best practices.
+Author-email: Scientific Software Engineering Center at Georgia Tech <sse-center@gatech.edu>
+License: MIT
+Project-URL: Homepage, https://github.com/gt-sse-center/RepoAuditor
+Project-URL: Documentation, https://github.com/gt-sse-center/RepoAuditor
+Project-URL: Repository, https://github.com/gt-sse-center/RepoAuditor
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: typer ~=0.9
+Provides-Extra: dev
+Requires-Dist: dbrownell-DevTools ; extra == 'dev'
+Provides-Extra: package
+Requires-Dist: build ==1.* ; extra == 'package'
+Requires-Dist: cx-Freeze ==6.* ; extra == 'package'
+Requires-Dist: twine ==4.* ; extra == 'package'
+
+# RepoAuditor
+
+
+
+Audits repositories for best practices.
+
+### Overview
+
+TODO: Complete this section
+
+### How to use RepoAuditor
+
+TODO: Complete this section
+
+## Installation via Executable
+
+Download an executable for Linux, MacOS, or Windows to use the functionality provided by this repository without a dependency on [Python](https://www.python.org).
+
+1. Download the archive for the latest release [here](https://github.com/gt-sse-center/RepoAuditor/releases/latest); the files will begin with `exe.` and contain the name of your operating system.
+2. Decompress the archive
+
+## Installation via pip
+
+Install the RepoAuditor package via [pip](https://pip.pypa.io/en/stable/) (Package Installer for Python) to use it with your python code.
+
+`pip install RepoAuditor`
+
+
+
+## License
+
+RepoAuditor is licensed under the <a href="https://choosealicense.com/licenses/mit/" target="_blank">MIT</a> license.

RepoAuditor-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+BuildBinary.py,sha256=GTuOdK1NcrWKvC4hkr9MtiTSMXF8Rys-ZVxVjP7o36Y,3592
+RepoAuditor/EntryPoint.py,sha256=LdikUVpdsgDybB4kcdHFJfSQ4hGFGbLMoJdekSRg-pc,2572
+RepoAuditor/Math.py,sha256=wznhaBVUBEB9EZb7gi33SPY4_HvlVEoK3VqmgU4nwXc,876
+RepoAuditor/__init__.py,sha256=OSGR6BFauVgn_m8uagk7xa55kz_dV1S8SI0Dj2J0CQw,639
+RepoAuditor-0.1.0.dist-info/LICENSE.txt,sha256=zc7f3T2QcYWfeQLzALc_PNFXPegKkIYxfFvfCGOtVFg,1132
+RepoAuditor-0.1.0.dist-info/METADATA,sha256=QHI_3FgM8vARg4Nru574orqCgDtZ7hZhW5TVLwGSbPw,2044
+RepoAuditor-0.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+RepoAuditor-0.1.0.dist-info/entry_points.txt,sha256=eN5Hrko0L0F4jJSGdVScI90f2MeHmFwsjbXICW_Ibk8,59
+RepoAuditor-0.1.0.dist-info/top_level.txt,sha256=dg-IQ-OWnx12k00Iioc5mToRnfq3wnQyUmQ-Py5BjCI,24
+RepoAuditor-0.1.0.dist-info/RECORD,,

RepoAuditor-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

RepoAuditor-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+RepoAuditor = RepoAuditor:EntryPoint.app

RepoAuditor-0.1.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+BuildBinary
+RepoAuditor