muck-sig 0.1.0__tar.gz

muck_sig-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Muck
+
+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.

muck_sig-0.1.0/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.5
+Name: muck_sig
+Version: 0.1.0
+Summary: A small attribution banner for Python projects made by Muck.
+Project-URL: Discord, https://discord.gg/JjkF6YENgy
+Author: Muck
+License: MIT
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# muck_sig
+
+Add a short Muck attribution banner to a Python project.
+
+## Install
+
+```bash
+pip install muck_sig
+```
+
+## Use
+
+```python
+from muck_sig import sign
+
+sign()
+```
+
+This prints:
+
+```text
+This project is made by Muck, https://discord.gg/JjkF6YENgy
+```
+
+By default, the message remains visible for two seconds and then the terminal is cleared. Configure either behavior when needed:
+
+```python
+sign(delay=0, clear_screen=False)
+```
+
+## Publishing to PyPI
+
+Choose an available project name on PyPI if `muck_sig` is already taken, then build and upload:
+
+```bash
+python -m pip install --upgrade build twine
+python -m build
+python -m twine upload dist/*
+```

muck_sig-0.1.0/README.md

@@ -0,0 +1,39 @@
+# muck_sig
+
+Add a short Muck attribution banner to a Python project.
+
+## Install
+
+```bash
+pip install muck_sig
+```
+
+## Use
+
+```python
+from muck_sig import sign
+
+sign()
+```
+
+This prints:
+
+```text
+This project is made by Muck, https://discord.gg/JjkF6YENgy
+```
+
+By default, the message remains visible for two seconds and then the terminal is cleared. Configure either behavior when needed:
+
+```python
+sign(delay=0, clear_screen=False)
+```
+
+## Publishing to PyPI
+
+Choose an available project name on PyPI if `muck_sig` is already taken, then build and upload:
+
+```bash
+python -m pip install --upgrade build twine
+python -m build
+python -m twine upload dist/*
+```

muck_sig-0.1.0/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "muck_sig"
+version = "0.1.0"
+description = "A small attribution banner for Python projects made by Muck."
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+authors = [{ name = "Muck" }]
+classifiers = [
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+]
+
+[project.urls]
+Discord = "https://discord.gg/JjkF6YENgy"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/muck_sig"]

muck_sig-0.1.0/src/muck_sig/__init__.py

@@ -0,0 +1,5 @@
+"""Project attribution banner for Muck-made Python projects."""
+
+from .signature import DISCORD_URL, MESSAGE, sign
+
+__all__ = ["DISCORD_URL", "MESSAGE", "sign"]

muck_sig-0.1.0/src/muck_sig/signature.py

@@ -0,0 +1,24 @@
+"""Utilities for showing the Muck project attribution banner."""
+
+import os
+import time
+
+DISCORD_URL = "https://discord.gg/JjkF6YENgy"
+MESSAGE = f"This project is made by Muck, {DISCORD_URL}"
+
+
+def sign(delay: float = 2, clear_screen: bool = True) -> None:
+    """Print Muck's attribution, optionally wait, then clear the terminal.
+
+    Args:
+        delay: Seconds to leave the message visible. Must not be negative.
+        clear_screen: Whether to clear the current terminal afterwards.
+    """
+    if delay < 0:
+        raise ValueError("delay must be zero or greater")
+
+    print(MESSAGE)
+    time.sleep(delay)
+
+    if clear_screen:
+        os.system("cls" if os.name == "nt" else "clear")

muck_sig-0.1.0/tests/test_signature.py

@@ -0,0 +1,14 @@
+import pytest
+
+from muck_sig import MESSAGE, sign
+
+
+def test_sign_prints_message_without_clearing(capsys):
+    sign(delay=0, clear_screen=False)
+
+    assert capsys.readouterr().out == f"{MESSAGE}\n"
+
+
+def test_sign_rejects_negative_delay():
+    with pytest.raises(ValueError, match="delay must be zero or greater"):
+        sign(delay=-1, clear_screen=False)