FileBackup 0.1.0__py3-none-any.whl

FileBackup/EntryPoint.py

@@ -0,0 +1,92 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 David Brownell
+# |  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 FileBackup 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

FileBackup/Math.py

@@ -0,0 +1,27 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 David Brownell
+# |  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

FileBackup/__init__.py

@@ -0,0 +1,14 @@
+# ----------------------------------------------------------------------
+# |
+# |  Copyright (c) 2024 David Brownell
+# |  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 by the Continuous Integration system as part of a commit.
+__version__ = "0.1.0"
+
+from .Math import Add, Sub, Mult, Div

FileBackup-0.1.0.dist-info/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) 2024 David Brownell
+
+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.

FileBackup-0.1.0.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.1
+Name: FileBackup
+Version: 0.1.0
+Summary: Tool for creating and restoring file system backups.
+Author-email: David Brownell <db@DavidBrownell.com>
+License: MIT
+Project-URL: Homepage, https://github.com/davidbrownell/FileBackup
+Project-URL: Documentation, https://github.com/davidbrownell/FileBackup
+Project-URL: Repository, https://github.com/davidbrownell/FileBackup
+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.2 ; extra == 'package'
+Requires-Dist: cx-Freeze ~=6.15 ; extra == 'package'
+Requires-Dist: twine ~=4.0 ; extra == 'package'
+
+# FileBackup
+
+
+
+Tool for creating and restoring file system backups.
+
+
+
+## Overview
+
+TODO: Complete this section
+
+### How to use FileBackup
+
+TODO: Complete this section
+
+
+
+## Vulnerability Reporting (Security Issues)
+Please privately report vulnerabilities you find so we can fix them!
+
+See [SECURITY.md](https://github.com/davidbrownell/FileBackup/blob/main/SECURITY.md) for information on how to privately report vulnerabilities.
+
+## License
+
+FileBackup is licensed under the <a href="https://choosealicense.com/licenses/mit/" target="_blank">MIT</a> license.

FileBackup-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+FileBackup/EntryPoint.py,sha256=03gYjKoAyKjm1MmKvm6L6aMbZ4y6O41ICQIK-zA3WGU,2531
+FileBackup/Math.py,sha256=MtgI9Z0NRqGDttTofzM2UPlD3u4Lm91pxKX5Dl65nIQ,836
+FileBackup/__init__.py,sha256=cNJUaqD75ik7caZw0N_c6pLhso3QEHMnPu1YW-M6jOI,636
+FileBackup-0.1.0.dist-info/LICENSE.txt,sha256=P0fqGEJwVh6ADlvhWsPNxwWII2O0VaoyMKUcjDqsOOM,1092
+FileBackup-0.1.0.dist-info/METADATA,sha256=m1K2Qia9S57v-F0KjrGQ33zGPJURFHamlrEfV6gBT4Y,1674
+FileBackup-0.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+FileBackup-0.1.0.dist-info/entry_points.txt,sha256=yAP7Q5zpFpXJVQ6dUoLHFaOBuN55_I8O6hjw9oDgCVE,57
+FileBackup-0.1.0.dist-info/top_level.txt,sha256=mXd2b6GEOpQCnmzgYEb6c_rfwlgP3RgmMuVDkQasxKw,11
+FileBackup-0.1.0.dist-info/RECORD,,

FileBackup-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
+

FileBackup-0.1.0.dist-info/entry_points.txt

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

FileBackup-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+FileBackup