| Name | dming JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | DMing is a CLI (command-line interface) collection useful when running a TTRPG (tabletop role-playing games). |
| upload_time | 2025-07-30 23:12:22 |
| maintainer | None |
| docs_url | None |
| author | Saúl Piña |
| requires_python | <3.14,>=3.13 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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>
```
Raw data
{
"_id": null,
"home_page": null,
"name": "dming",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.13",
"maintainer_email": null,
"keywords": null,
"author": "Sa\u00fal Pi\u00f1a",
"author_email": "sauljabin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/d6/77/d2f77c3617d0a8102dfe29e6f04f6ffa17aab6c0da91cf8d0f01259baa54/dming-0.1.0.tar.gz",
"platform": null,
"description": "# DMing\n\nDMing is a CLI (command-line interface) collection useful when running a TTRPG (tabletop role-playing game).\n\n> *[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.*\n\n## Installation\n\n```sh\npipx install dming\n```\n\n## Usage\n\n### Roll Dice\n\n> [!WARNING]\n> DMing supports part of the [Roll20 Dice Specification](https://help.roll20.net/hc/en-us/articles/360037773133-Dice-Reference).\n\nUse the command `roll <dice>`.\n\nExamples:\n\n* `roll 1d20`: roll a d20 die\n* `roll 1d100`: roll a d100 die\n* `roll 2d20kh1`: roll with advantage\n* `roll 2d20kl1`: roll with disadvantage\n* `roll 2d20dl1`: roll with advantage\n* `roll 2d20dh1`: roll with disadvantage\n* `roll 1d20+4`: roll a d20 die with a +4 modifier\n* `roll 1d20-4`: roll a d20 die with a -4 modifier\n\n> [!NOTE]\n> `kh`: keep highest \\\n> `kl`: keep lowest \\\n> `dh`: drop highest \\\n> `dl`: drop lowest\n\n### Using the Library\n\n<a href=\"https://pypi.org/project/dming\"><img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/dming?label=dming\"></a>\n\n\n```python\nfrom dming.dice import roll\n\noperation, result = roll(\"1d20+2\")\n```\n\n## Alternatives\n\n* JavaScript: [Dice Roller & Parser](https://www.npmjs.com/package/dice-roller-parser).\n\n## Development\n\nInstalling poetry:\n\n```shell\npipx install poetry\n```\n\nInstalling development dependencies:\n\n```shell\npoetry install\n```\n\nRun:\n\n```shell\npoetry run roll <dice>\n```\n\n## Release a new version\n\n> Check https://python-poetry.org/docs/cli/#version\n\n```shell\npoetry run python -m scripts.bump --help\npoetry run python -m scripts.bump <major|minor|patch>\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DMing is a CLI (command-line interface) collection useful when running a TTRPG (tabletop role-playing games).",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "401dda9d0cdb04622d347ecdf09b73d9471c6c44f22b10fbe96ad9d7166ebe99",
"md5": "0f5289d4c8ffd01187c99a9415438e5d",
"sha256": "492896379fd137b97f21b2e437066d9692a3a3ab0c59322c343ad3e17e9349ef"
},
"downloads": -1,
"filename": "dming-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f5289d4c8ffd01187c99a9415438e5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.13",
"size": 4199,
"upload_time": "2025-07-30T23:12:20",
"upload_time_iso_8601": "2025-07-30T23:12:20.696990Z",
"url": "https://files.pythonhosted.org/packages/40/1d/da9d0cdb04622d347ecdf09b73d9471c6c44f22b10fbe96ad9d7166ebe99/dming-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d677d2f77c3617d0a8102dfe29e6f04f6ffa17aab6c0da91cf8d0f01259baa54",
"md5": "d521f052ba9278c4b5a69dd04cbf42a7",
"sha256": "602cf58ab8fd00db6d254cb232217809151556aba9553d0dff3a79915a230c1d"
},
"downloads": -1,
"filename": "dming-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "d521f052ba9278c4b5a69dd04cbf42a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.13",
"size": 3097,
"upload_time": "2025-07-30T23:12:22",
"upload_time_iso_8601": "2025-07-30T23:12:22.100500Z",
"url": "https://files.pythonhosted.org/packages/d6/77/d2f77c3617d0a8102dfe29e6f04f6ffa17aab6c0da91cf8d0f01259baa54/dming-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-30 23:12:22",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "dming"
}
