dming 0.1.0__tar.gz

dming-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Saúl Piña
+
+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.

dming-0.1.0/PKG-INFO

@@ -0,0 +1,99 @@
+Metadata-Version: 2.3
+Name: dming
+Version: 0.1.0
+Summary: DMing is a CLI (command-line interface) collection useful when running a TTRPG (tabletop role-playing games).
+License: MIT
+Author: Saúl Piña
+Author-email: sauljabin@gmail.com
+Requires-Python: >=3.13,<3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Environment :: Console
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: click (>=8.2.1,<9.0.0)
+Requires-Dist: rich (>=14.1.0,<15.0.0)
+Description-Content-Type: text/markdown
+
+# DMing
+
+DMing is a CLI (command-line interface) collection useful when running a TTRPG (tabletop role-playing game).
+
+> *[DMing](https://en.wiktionary.org/wiki/DMing)([Dungeon Mastering](https://en.wiktionary.org/wiki/Dungeon_Mastering#English)): Performing as a dungeon master, or running a tabletop role-playing game, especially Dungeons & Dragons.*
+
+## Installation
+
+```sh
+pipx install dming
+```
+
+## Usage
+
+### Roll Dice
+
+> [!WARNING]
+> DMing supports part of the [Roll20 Dice Specification](https://help.roll20.net/hc/en-us/articles/360037773133-Dice-Reference).
+
+Use the command `roll <dice>`.
+
+Examples:
+
+* `roll 1d20`: roll a d20 die
+* `roll 1d100`: roll a d100 die
+* `roll 2d20kh1`: roll with advantage
+* `roll 2d20kl1`: roll with disadvantage
+* `roll 2d20dl1`: roll with advantage
+* `roll 2d20dh1`: roll with disadvantage
+* `roll 1d20+4`: roll a d20 die with a +4 modifier
+* `roll 1d20-4`: roll a d20 die with a -4 modifier
+
+> [!NOTE]
+> `kh`: keep highest \
+> `kl`: keep lowest \
+> `dh`: drop highest \
+> `dl`: drop lowest
+
+### Using the Library
+
+<a href="https://pypi.org/project/dming"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/dming?label=dming"></a>
+
+
+```python
+from dming.dice import roll
+
+operation, result = roll("1d20+2")
+```
+
+## Alternatives
+
+* JavaScript: [Dice Roller & Parser](https://www.npmjs.com/package/dice-roller-parser).
+
+## Development
+
+Installing poetry:
+
+```shell
+pipx install poetry
+```
+
+Installing development dependencies:
+
+```shell
+poetry install
+```
+
+Run:
+
+```shell
+poetry run roll <dice>
+```
+
+## Release a new version
+
+> Check https://python-poetry.org/docs/cli/#version
+
+```shell
+poetry run python -m scripts.bump --help
+poetry run python -m scripts.bump <major|minor|patch>
+```
+

dming-0.1.0/README.md

@@ -0,0 +1,81 @@
+# DMing
+
+DMing is a CLI (command-line interface) collection useful when running a TTRPG (tabletop role-playing game).
+
+> *[DMing](https://en.wiktionary.org/wiki/DMing)([Dungeon Mastering](https://en.wiktionary.org/wiki/Dungeon_Mastering#English)): Performing as a dungeon master, or running a tabletop role-playing game, especially Dungeons & Dragons.*
+
+## Installation
+
+```sh
+pipx install dming
+```
+
+## Usage
+
+### Roll Dice
+
+> [!WARNING]
+> DMing supports part of the [Roll20 Dice Specification](https://help.roll20.net/hc/en-us/articles/360037773133-Dice-Reference).
+
+Use the command `roll <dice>`.
+
+Examples:
+
+* `roll 1d20`: roll a d20 die
+* `roll 1d100`: roll a d100 die
+* `roll 2d20kh1`: roll with advantage
+* `roll 2d20kl1`: roll with disadvantage
+* `roll 2d20dl1`: roll with advantage
+* `roll 2d20dh1`: roll with disadvantage
+* `roll 1d20+4`: roll a d20 die with a +4 modifier
+* `roll 1d20-4`: roll a d20 die with a -4 modifier
+
+> [!NOTE]
+> `kh`: keep highest \
+> `kl`: keep lowest \
+> `dh`: drop highest \
+> `dl`: drop lowest
+
+### Using the Library
+
+<a href="https://pypi.org/project/dming"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/dming?label=dming"></a>
+
+
+```python
+from dming.dice import roll
+
+operation, result = roll("1d20+2")
+```
+
+## Alternatives
+
+* JavaScript: [Dice Roller & Parser](https://www.npmjs.com/package/dice-roller-parser).
+
+## Development
+
+Installing poetry:
+
+```shell
+pipx install poetry
+```
+
+Installing development dependencies:
+
+```shell
+poetry install
+```
+
+Run:
+
+```shell
+poetry run roll <dice>
+```
+
+## Release a new version
+
+> Check https://python-poetry.org/docs/cli/#version
+
+```shell
+poetry run python -m scripts.bump --help
+poetry run python -m scripts.bump <major|minor|patch>
+```

dming-0.1.0/dming/__init__.py

@@ -0,0 +1,3 @@
+from importlib.metadata import version
+
+__version__ = version("dming")

dming-0.1.0/dming/cli.py

@@ -0,0 +1,39 @@
+import click
+
+from dming.dice import roll
+from dming import __version__
+
+from rich.console import Console
+
+
+@click.command()
+@click.argument("dice")
+@click.option(
+    "-v", "verbose", help="Verbose output. Show the arithmetic operation.", is_flag=True
+)
+@click.version_option(__version__)
+def _roll(dice: str, verbose: bool) -> None:
+    """
+    Allows you to roll dice from your terminal.
+
+    \b
+    Examples:
+         roll 1d20    # roll a d20 die
+         roll 1d100   # roll a d100 die
+         roll 2d20kh1 # roll with advantage
+         roll 2d20kl1 # roll with disadvantage
+         roll 2d20dl1 # roll with advantage
+         roll 2d20dh1 # roll with disadvantage
+         roll 1d20+4  # roll a d20 die with a +4 modifier
+         roll 1d20-4  # roll a d20 die with a -4 modifier
+    """
+    try:
+        operation, result = roll(dice)
+        if verbose:
+            console = Console()
+            console.print(f"{operation}={result}")
+        else:
+            print(f"{result}")
+    except Exception as e:
+        print(f"Invalid operation: {e}")
+        exit(-1)

dming-0.1.0/dming/dice.py

@@ -0,0 +1,40 @@
+import re
+import random
+
+
+def kh(n: int, dice: list[int]) -> list[int]:
+    return sorted(dice, reverse=True)[:n]
+
+
+def kl(n: int, dice: list[int]) -> list[int]:
+    return sorted(dice)[:n]
+
+
+def dh(n: int, dice: list[int]) -> list[int]:
+    return sorted(dice, reverse=True)[n:]
+
+
+def dl(n: int, dice: list[int]) -> list[int]:
+    return sorted(dice)[n:]
+
+
+FILTERS = {"kh": kh, "kl": kl, "dh": dh, "dl": dl}
+
+
+def roll(dice: str) -> tuple[str, int]:
+    def replacer(expression: re.Match[str]):
+        total, die, filter, total_keep = expression.groups()
+        dice = [random.randint(1, int(die)) for _ in range(int(total) if total else 1)]
+        filtered_dice = (
+            FILTERS[filter](int(total_keep) if total_keep else 1, dice)
+            if filter
+            else dice
+        )
+        return str(sum(filtered_dice))
+
+    operation = re.sub(r"(\d+)?d(\d+)(kh|kl|dh|dl)?(\d+)?", replacer, dice)
+
+    if not re.match(r"^[0-9+-]+$", operation):
+        raise Exception("not allowed characters")
+
+    return operation, eval(operation)

dming-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "dming"
+version = "0.1.0"
+description = "DMing is a CLI (command-line interface) collection useful when running a TTRPG (tabletop role-playing games)."
+authors = [
+    {name = "Saúl Piña",email = "sauljabin@gmail.com"}
+]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Environment :: Console",
+    "Operating System :: MacOS",
+    "Operating System :: Unix",
+    "Programming Language :: Python :: 3.13",
+]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.13,<3.14"
+dependencies = [
+    "click (>=8.2.1,<9.0.0)",
+    "rich (>=14.1.0,<15.0.0)"
+]
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+
+[project.scripts]
+roll = "dming.cli:_roll"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.group.dev.dependencies]
+faker = "*"