memoryframes 0.1.5__py3-none-any.whl

MemoryFrames/EntryPoint.py

@@ -0,0 +1,85 @@
+"""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 MemoryFrames import Math, __version__
+
+
+# ----------------------------------------------------------------------
+class NaturalOrderGrouper(TyperGroup):  # noqa: D101
+    # ----------------------------------------------------------------------
+    def list_commands(self, *args, **kwargs) -> list[str]:  # noqa: ARG002, D102
+        return list(self.commands.keys())  # pragma: no cover
+
+
+# ----------------------------------------------------------------------
+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:
+    """Add 2 values."""
+
+    sys.stdout.write(str(Math.Add(x, y)))
+
+
+# ----------------------------------------------------------------------
+@app.command("Sub")
+def Sub(
+    x: int,
+    y: int,
+) -> None:
+    """Subtract 2 values."""
+
+    sys.stdout.write(str(Math.Sub(x, y)))
+
+
+# ----------------------------------------------------------------------
+@app.command("Mult")
+def Mult(
+    x: int,
+    y: int,
+) -> None:
+    """Multiplie 2 values."""
+
+    sys.stdout.write(str(Math.Mult(x, y)))
+
+
+# ----------------------------------------------------------------------
+@app.command("Div")
+def Div(
+    x: int,
+    y: int,
+) -> None:
+    """Divide 1 value by another."""
+
+    sys.stdout.write(str(Math.Div(x, y)))
+
+
+# ----------------------------------------------------------------------
+@app.command("Version")
+def Version() -> None:
+    """Print the version of the package."""
+
+    sys.stdout.write(__version__)
+
+
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+# ----------------------------------------------------------------------
+if __name__ == "__main__":
+    app()  # pragma: no cover

MemoryFrames/Math.py

@@ -0,0 +1,21 @@
+"""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):  # noqa: ANN001, ANN201, D103
+    return x + y
+
+
+# ----------------------------------------------------------------------
+def Sub(x, y):  # noqa: ANN001, ANN201, D103
+    return x - y
+
+
+# ----------------------------------------------------------------------
+def Mult(x, y):  # noqa: ANN001, ANN201, D103
+    return x * y
+
+
+# ----------------------------------------------------------------------
+def Div(x, y):  # noqa: ANN001, ANN201, D103
+    return x / y

MemoryFrames/__init__.py

@@ -0,0 +1,15 @@
+# noqa: D104
+
+from importlib.metadata import version
+
+from .Math import Add, Sub, Mult, Div
+
+
+__all__ = [
+    "Add",
+    "Div",
+    "Mult",
+    "Sub",
+]
+
+__version__ = version("MemoryFrames")

memoryframes-0.1.5.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.3
+Name: memoryframes
+Version: 0.1.5
+Summary: Add your description here
+Author: David Brownell
+Author-email: David Brownell <github@DavidBrownell.com>
+License: MIT
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
+Project-URL: Documentation, https://github.com/davidbrownell/MemoryFrames
+Project-URL: Homepage, https://github.com/davidbrownell/MemoryFrames
+Project-URL: Repository, https://github.com/davidbrownell/MemoryFrames
+Description-Content-Type: text/markdown
+
+**Project:**
+[![License](https://img.shields.io/github/license/davidbrownell/MemoryFrames?color=dark-green)](https://github.com/davidbrownell/MemoryFrames/blob/master/LICENSE)
+
+**Package:**
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/MemoryFrames?color=dark-green)](https://pypi.org/project/MemoryFrames/)
+[![PyPI - Version](https://img.shields.io/pypi/v/MemoryFrames?color=dark-green)](https://pypi.org/project/MemoryFrames/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/MemoryFrames)](https://pypistats.org/packages/memoryframes)
+
+**Development:**
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![CI](https://github.com/davidbrownell/MemoryFrames/actions/workflows/CICD.yml/badge.svg)](https://github.com/davidbrownell/MemoryFrames/actions/workflows/CICD.yml)
+[![Code Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/davidbrownell/f15146b1b8fdc0a5d45ac0eb786a84f7/raw/MemoryFrames_code_coverage.json)](https://github.com/davidbrownell/MemoryFrames/actions)
+[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/davidbrownell/MemoryFrames?color=dark-green)](https://github.com/davidbrownell/MemoryFrames/commits/main/)
+
+<!-- Content above this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
+
+## Contents
+- [Overview](#overview)
+- [Installation](#installation)
+- [Development](#development)
+- [Additional Information](#additional-information)
+- [License](#license)
+
+## Overview
+TODO: Complete this section
+
+### How to use `MemoryFrames`
+TODO: Complete this section
+
+<!-- Content below this delimiter will be copied to the generated README.md file. DO NOT REMOVE THIS COMMENT, as it will cause regeneration to fail. -->
+
+## Installation
+
+| Installation Method | Command |
+| --- | --- |
+| Via [uv](https://github.com/astral-sh/uv) | `uv add MemoryFrames` |
+| Via [pip](https://pip.pypa.io/en/stable/) | `pip install MemoryFrames` |
+
+### Verifying Signed Artifacts
+Artifacts are signed and verified using [py-minisign](https://github.com/x13a/py-minisign) and the public key in the file `./minisign_key.pub`.
+
+To verify that an artifact is valid, visit [the latest release](https://github.com/davidbrownell/MemoryFrames/releases/latest) and download the `.minisign` signature file that corresponds to the artifact, then run the following command, replacing `<filename>` with the name of the artifact to be verified:
+
+```shell
+uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>'); print('The file has been verified.')"
+```
+
+## Development
+Please visit [Contributing](https://github.com/davidbrownell/MemoryFrames/blob/main/CONTRIBUTING.md) and [Development](https://github.com/davidbrownell/MemoryFrames/blob/main/DEVELOPMENT.md) for information on contributing to this project.
+
+## Additional Information
+Additional information can be found at these locations.
+
+| Title | Document | Description |
+| --- | --- | --- |
+| Code of Conduct | [CODE_OF_CONDUCT.md](https://github.com/davidbrownell/MemoryFrames/blob/main/CODE_OF_CONDUCT.md) | Information about the norms, rules, and responsibilities we adhere to when participating in this open source community. |
+| Contributing | [CONTRIBUTING.md](https://github.com/davidbrownell/MemoryFrames/blob/main/CONTRIBUTING.md) | Information about contributing to this project. |
+| Development | [DEVELOPMENT.md](https://github.com/davidbrownell/MemoryFrames/blob/main/DEVELOPMENT.md) | Information about development activities involved in making changes to this project. |
+| Governance | [GOVERNANCE.md](https://github.com/davidbrownell/MemoryFrames/blob/main/GOVERNANCE.md) | Information about how this project is governed. |
+| Maintainers | [MAINTAINERS.md](https://github.com/davidbrownell/MemoryFrames/blob/main/MAINTAINERS.md) | Information about individuals who maintain this project. |
+| Security | [SECURITY.md](https://github.com/davidbrownell/MemoryFrames/blob/main/SECURITY.md) | Information about how to privately report security issues associated with this project. |
+
+## License
+`MemoryFrames` is licensed under the <a href="https://choosealicense.com/licenses/MIT/" target="_blank">MIT</a> license.

memoryframes-0.1.5.dist-info/RECORD

@@ -0,0 +1,7 @@
+MemoryFrames/EntryPoint.py,sha256=E-W_pvWKE-XNnojmCe49O0hpl4prVt5WErc-9Fkd5uU,2177
+MemoryFrames/Math.py,sha256=MC3_eH_FA0zUF8z_r5giRbihPfgJPJVoVendGp1_og0,696
+MemoryFrames/__init__.py,sha256=CZiDRIx18WLhiZqavHaMXM1sojG9kdCAU9N8R6PcU5c,192
+MemoryFrames/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+memoryframes-0.1.5.dist-info/WHEEL,sha256=Jb20R3Ili4n9P1fcwuLup21eQ5r9WXhs4_qy7VTrgPI,79
+memoryframes-0.1.5.dist-info/METADATA,sha256=KdDIdQ6epvYqMGATg-vkCmdffI5iWNRHvEKBB_vaQ0s,5305
+memoryframes-0.1.5.dist-info/RECORD,,

memoryframes-0.1.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.8.15
+Root-Is-Purelib: true
+Tag: py3-none-any