dicetables 4.0.2__tar.gz → 4.0.2.post4__tar.gz

dicetables-4.0.2.post4/.coveragerc

@@ -0,0 +1,20 @@
+[run]
+branch = True
+source = .
+omit =
+    tests/*
+    .tox/*
+    setup.py
+    venv/*
+    time_trials/*
+    doctests.py
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError

dicetables-4.0.2.post4/.github/workflows/lint-and-format-checks.yaml

@@ -0,0 +1,23 @@
+name: Lint/Format Checks
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    types: ["opened", "reopened", "synchronize"]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+      - name: Run Ruff
+        run: ruff check --output-format=github .
+      - name: Check code formatting with Ruff
+        run: ruff format --diff

dicetables-4.0.2.post4/.github/workflows/pr-test.yaml

@@ -0,0 +1,29 @@
+name: PR testing
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    types: ["opened", "reopened", "synchronize"]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.12", "3.13"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install pytest pytest-cov
+    - name: Test with pytest
+      run: |
+        pytest . --cov=dicetables  --cov-report=xml
+        python doctests.py
+    - name: Coveralls
+      uses: coverallsapp/github-action@v2

dicetables-4.0.2.post4/.github/workflows/pre-release-jobs.yaml

@@ -0,0 +1,43 @@
+name: Upload Test Python Package
+on:
+  release:
+    types: [prereleased]
+permissions:
+  contents: read
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Build release distributions
+        run: |
+          python -m pip install build
+          python -m build
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+  pypi-publish:
+    name: Upload release to Test PyPI
+    runs-on: ubuntu-latest
+    needs: [release-build]
+    environment:
+      name: pre-release-pypi
+      url: https://test.pypi.org/p/dicetables
+    permissions:
+      id-token: write
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

dicetables-4.0.2.post4/.github/workflows/release-jobs.yaml

@@ -0,0 +1,41 @@
+name: Upload Python Package
+on:
+  release:
+    types: [released]
+permissions:
+  contents: read
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - name: Build release distributions
+        run: |
+          python -m pip install build
+          python -m build
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    needs: [release-build]
+    environment:
+      name: release-pypi
+      url: https://pypi.org/p/dicetables
+    permissions:
+      id-token: write
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

dicetables-4.0.2.post4/.gitignore

@@ -0,0 +1,31 @@
+# Compiled python modules.
+*.pyc
+
+# Setuptools distribution folder.
+/dist/
+/build/
+
+
+# Python egg metadata, regenerated from source files by setuptools.
+/*.egg-info
+/*.egg
+
+# other
+*.npy
+*.spec
+.coverage
+.tox
+.idea
+/time_trials/best_time_data
+/time_trials/i_v_timetrials_data
+!/time_trials/welcome_message.txt
+/docs/make.bat
+/docs/_build
+/_build
+run_sphinx.sh
+venv/
+
+# coverage
+htmlcov
+junit
+coverage.xml

dicetables-4.0.2.post4/.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.8.3
+  hooks:
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format

dicetables-4.0.2.post4/.readthedocs.yml

@@ -0,0 +1,29 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  install:
+    - requirements: docs/requirements.txt

dicetables-4.0.2.post4/CHANGELOG.md

@@ -0,0 +1,196 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+### Fixed
+
+- readthedocs.org jobs fixed.
+- coveralls now fixed with github actions.
+
+### Changed
+
+- updated infrastructure and readme for modern-ness
+- use pre-commit
+- use pyproject.toml
+- run CI/CD with github actions
+
+### Removed
+
+- tox.ini
+- travis ci
+
+## [4.0.2] - 2020-12-20
+
+This release is missing in Github
+
+### Added
+
+### Fixed
+
+fixed bug in Parser.  Before `Parser().parse_die("Die(1, 2, 3)")` returned `Die(1)`.  Now, it raises a ParserError.
+`Parser().parse_die("ModDie(1, 2, modifier=3")` also raises `ParserError` as does not enough arguments.
+
+### Changed
+
+### Removed
+
+## [4.0.0] - 2020-12-20
+
+This release is missing in Github
+
+closest release is [4.0.1](https://github.com/eric-s-s/dice-tables/releases/tag/4.0.1)
+
+### Added
+
+### Fixed
+
+### Changed
+
+**Breaking change again!**
+
+Revamped DicePools and the Parser.
+
+#### Dice Pools
+
+BestOfDicePool, WorstOfDicePool, UpperMidOfDicePool and LowerMidOfDicePool are now ProtoDie
+wrappers around a DicePool object.  :code:`DicePool(Die(6), 4)` is now a non-IntegerEvents
+object. It is immutable and can get passed around to various DicePoolCollection objects which
+are ProtoDie.  So now it is:
+
+```pycon
+>>> import dicetables as dt
+>>> pool = dt.DicePool(dt.Die(6), 4)
+>>> best_of = dt.BestOfDicePool(pool=pool, select=3)
+>>> worst_of = dt.BestOfDicePool(pool=pool, select=3)
+>>> super_best_of = dt.BestOfDicePool(pool=pool, select=1)
+```
+
+#### Parser
+
+The parser now takes a LimitChecker object.  This defaults to a NoOpLimitChecker
+which doesn't check limits and there's a class method to make a parser with a useful
+limit checker that is the same as the old behavior.  You can pass in your own limit
+checker provided that it inherits from
+`dicetables.tools.limit_checker.AbstractLimitChecker`.
+
+```pycon
+>>> from dicetables import Parser, Die, LimitsError
+>>> no_limit = Parser()
+>>> Die(1000) == no_limit.parse_die("Die(1000)")
+True
+>>> limited = Parser.with_limits()
+>>> limited.parse_die("Die(1000)")
+Traceback (most recent call last):
+File "<stdin>", line 1, in <module>
+LimitsError: Max die_size: 500
+```
+
+### Removed
+
+
+## [3.0.0](https://github.com/eric-s-s/dice-tables/releases/tag/v3.0.0) - 2020-09-20
+
+**Python 2 is no longer supported**
+
+### Added
+
+- type hinting
+
+### Fixed
+
+### Changed
+
+### Removed
+
+- python2 support
+
+
+## [2.6.0](https://github.com/eric-s-s/dice-tables/releases/tag/2.6.0) - 2020-04-04
+
+Last stable release that support python2 and python3
+
+### Added
+
+- `Roller`
+
+### Fixed
+
+### Changed
+
+- [DicePool](http://dice-tables.readthedocs.io/en/stable/the_dice.html#dice-pools)
+
+### Removed
+
+
+## [2.5.0]
+
+### Added
+
+- `DicePool` die objects:
+  - `BestOfDicePool`
+  - `WorstOfDicePool`
+  - `UpperMidOfDicePool`
+  - `LowerMidOfDicePool`
+
+### Fixed
+
+### Changed
+
+- `Parser().add_die_size_limit_kwarg` and `Parser().add_explosions_limit_kwarg` are removed. Use
+  `Parser().add_limits_kwarg`
+### Removed
+
+
+## [2.4.0]
+
+### Added
+
+- added `max_power_for_commaed` option to `EventsCalculations.full_table_string`.
+- added `max_power_for_commaed` and `min_power_for_fixed_pt` to `EventsCalculations.stats_strings`.
+
+### Fixed
+
+- fixed error where `parse_die_within_limits` failed when using default values for dice.
+- `Parser` can parse strings with leading and trailing whitespaces.
+- `parse_die_within_limits` now raises `LimitsError`
+-
+### Changed
+
+### Removed
+
+
+## [2.2.0]
+
+### Added
+
+- Added `parse_die_within_limits` function to parser. Also added limit values. Changed getters to properties.
+-
+### Fixed
+
+- Improved ExplodingOn speed.
+
+### Changed
+
+### Removed
+
+
+## [2.1.0]
+
+### Added
+
+- EventsCalculations added functions log10_points and log10_axes
+- New dice: Exploding(other_die, explosions=2), ExplodingOn(other_die, explodes_on, explosions=2)
+- New object: `Parser`. It converts strings to dice objects.
+
+### Fixed
+
+### Changed
+
+### Removed

dicetables-4.0.2.post4/LICENSE

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

dicetables-4.0.2.post4/PKG-INFO

@@ -0,0 +1,236 @@
+Metadata-Version: 2.4
+Name: dicetables
+Version: 4.0.2.post4
+Summary: get all combinations for any set of dice
+Project-URL: Homepage, https://allthedice.com
+Project-URL: Documentation, https://dice-tables.readthedocs.io/en/latest
+Project-URL: Repository, https://github.com/eric-s-s/dice-tables.git
+Project-URL: Issues, https://github.com/eric-s-s/dice-tables/issues
+Project-URL: Changelog, https://github.com/eric-s-s/dice-tables/blob/master/CHANGELOG.md
+Author-email: Eric Shaw <shaweric01@gmail.com>
+Maintainer-email: Eric Shaw <shaweric01@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2019 Eric Shaw
+        
+        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.
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Games/Entertainment :: Role-Playing
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+
+.. image:: https://img.shields.io/badge/License-MIT-yellow
+    :target: https://opensource.org/license/MIT
+
+.. image:: https://img.shields.io/badge/Python-3.9%20%7C%203.12%20%7C%203.13-blue
+
+.. image:: https://badge.fury.io/py/dicetables.svg
+    :target: https://badge.fury.io/py/dicetables
+
+.. image:: https://coveralls.io/repos/github/eric-s-s/dice-tables/badge.svg?branch=master
+    :target: https://coveralls.io/github/eric-s-s/dice-tables?branch=master
+
+.. image:: https://static.pepy.tech/badge/dicetables
+    :target: https://pepy.tech/projects/dicetables
+
+
+
+#################
+dicetables v4.0.2
+#################
+
+Calculate the Combinations For Any Set of Dice
+==============================================
+
+Have you ever wondered what the chances were for killing that 25 hp creature
+with your lvl-5 fireball? Of course you have(it's 3.24%. Good luck with that).
+What about if you could use your loaded dice that roll 6 twice as often.
+We've got you covered (still only a 10% chance). Want to make sure
+you'll win a bet on a number spread for DND dice randomly grabbed from a bag?
+No problem("i'll bet you can't roll 150-200 on 7D4, 4D8, 5D12 and 4D20" ...
+because it's a 0.3% chance). Ever wondered what would happen if you flipped a
+coin a thousand times? (Your chance of flipping heads more than 600 times
+is 0.000000009%.)
+
+Impress your friends. Wow the gender of your choice -
+with .... DICETABLES!!!
+
+Getting Started
+===============
+
+This module has no dependencies and no requirements. So to get started, simply:
+
+.. code-block:: bash
+
+    $ pip install dicetables
+
+or:
+
+.. code-block:: bash
+
+    $ git clone https://github.com/eric-s-s/dice-tables.git
+    $ cd dice-tables
+    $ python setup.py install
+
+The basic objects to use are DiceTable or DetailedDiceTable, and any of the dice classes.  They are:
+
+- Die
+- ModDie
+- WeightedDie
+- ModWeightedDie
+- Modifier
+- StrongDie
+- Exploding
+- ExplodingOn
+- BestOfDicePool
+- WorstOfDicePool
+- UpperMidOfDicePool
+- LowerMidOfDicePool
+
+for details about the dice, see `The Dice <https://dice-tables.readthedocs.io/en/latest/the_dice.html>`_.
+for details about the dice-tables see
+`DiceTable and DetailedDiceTable <http://dice-tables.readthedocs.io/en/latest/the_dicetable.html>`_
+
+These are all immutable objects. When you add dice to a DiceTable, it returns a new object and
+doesn't alter the original. Use the :code:`DiceTable.new()` class method to create an empty DiceTable.
+
+>>> import dicetables as dt
+>>> empty = dt.DiceTable.new()
+>>> empty
+<DiceTable containing []>
+>>> empty.add_die(dt.Die(6), times=10)
+<DiceTable containing [10D6]>
+>>> empty
+<DiceTable containing []>
+>>> table = empty.add_die(dt.Die(4), times=3)
+>>> table = table.add_die(dt.Die(10), times=5)
+>>> table.get_list()
+[(Die(4), 3), (Die(10), 5)]
+>>> print(table.get_dict())  # This is each roll and how many times it occurs.
+{8: 1,
+ 9: 8,
+ 10: 36,
+ 11: 120,
+ 12: 327,
+ ...
+ ...
+ 55: 3072,
+ 56: 1608,
+ 57: 768,
+ 58: 327,
+ 59: 120,
+ 60: 36,
+ 61: 8,
+ 62: 1}
+
+To get more detailed information, use
+`EventsCalculations <http://dice-tables.readthedocs.io/en/latest/events_info.html>`_.
+It can get the mean, stddev, a nice string of the
+combinations, points and axes for graphing, and stats for any set of rolls.
+
+>>> calculator = dt.EventsCalculations(table)
+>>> calculator.mean()
+35.0
+>>> calculator.stddev(decimal_place=8)
+6.70820393
+>>> calculator.stats_strings(list(range(8, 20)) + [35] + list(range(50, 63)))
+StatsStrings(query_values='8-19, 35, 50-62',
+             query_occurrences='515,778',
+             total_occurrences='6,400,000',
+             one_in_chance='12.41',
+             pct_chance='8.059')
+>>> calculator.percentage_points()
+[(8, 1.5624999999999997e-05),
+ (9, 0.00012499999999999998),
+ (10, 0.0005625),
+ ...
+ (59, 0.001875),
+ (60, 0.0005625),
+ (61, 0.00012499999999999998),
+ (62, 1.5624999999999997e-05)]
+>>> big_table = dt.DetailedDiceTable.new().add_die(dt.Die(6), 1000)
+>>> print(big_table.calc.full_table_string())  # DetailedDiceTable owns an EventsCalculations
+1000: 1
+1001: 1,000
+1002: 500,500
+1003: 1.672e+8
+1004: 4.192e+10
+1005: 8.417e+12
+...
+3513: 1.016e+776
+3514: 1.012e+776
+3515: 1.007e+776
+3516: 1.001e+776
+3517: 9.957e+775
+3518: 9.898e+775
+...
+5998: 500,500
+5999: 1,000
+6000: 1
+
+You can now roll events with a `Roller`
+
+>>> events = dt.DiceTable.new().add_die(dt.Die(6))
+>>> roller = dt.Roller(events)
+>>> roller.roll() in [1, 2, 3, 4, 5, 6]
+True
+
+That should get you started. For details see
+`<http://dice-tables.readthedocs.io/en/latest/>`_
+
+and the github repository at `<https://github.com/eric-s-s/dice-tables>`_
+
+-----------------
+Local Development
+-----------------
+
+If you want to contribute, you'll need to install the dev requirements.
+
+.. code-block:: bash
+
+    $ git clone https://github.com/eric-s-s/dice-tables.git
+    $ cd dice-tables
+    $ pip install --upgrade pip && pip install -r dev.requirements.txt
+    $ pytest . --cov=dicetables
+    $ pre-commit install
+    $ pre-commit run -a
+
+To build the docs:
+
+.. code-block:: bash
+
+    $ sphinx-build -M html docs build
+
+and then open ./build/html/index.html in your browser
+
+to build a distribution:
+
+.. code-block:: bash
+
+    $ python -m build --sdist
+    $ python -m build --wheel
+
+and then you can pip install them directly.