Metadata-Version: 1.2
Name: xdice
Version: 1.1.2
Summary: The swiss knife for Dice roll : Command line, API (documented!), advanced dice notation parser, compilable patterns...etc.
Home-page: https://github.com/cro-ki/xdice
Author: Olivier Massot
Author-email: croki.contact@gmail.com
License: GNU
Description: |Build Status| |Coverage Status| |Documentation Status|

        

        **xdice**

        

        *xdice* is a lightweight python library for managing dice, scores, and

        dice-notation patterns.

        

        It allows to easily interpret literal expressions as rolls of dice

        ('1d6', '3d4+3', '12d6+1d4'...etc.), then manipulate the results.

        

        Python Versions

        ^^^^^^^^^^^^^^^

        

        DiceRollParser has been tested with **python 3.3+**

        

        Documentation

        ~~~~~~~~~~~~~

        

        See the **`full

        documentation <https://xdice.readthedocs.io/en/latest/>`__**

        

        Examples:

        ^^^^^^^^^

        

        ::

        

            import dice

        

            ## Roll simple dices with **rolldice()**

        

            score = rolldice(6, amount=2)

        

            # manipulates score as an integer

        

            print( score, score * 2, score == 11 )

            >> 11       22      True

        

        

            # Iterates over the results

        

            for result in score:

                print(result)

            >> 5

            >> 6

        

            # Parse patterns with **roll()**

        

            ps = roll("2d6+18")

        

            print( ps, ps.format() )

            >> 28       '[5,6]+18'

        

        CLI

        ^^^

        

        Run ``python roll.py [options] <expr>``

        

        ::

        

            Usage:

                roll [options] <expr>

        

            Options:

                -s               Numeric score only

        

                -h --help        Displays help message

                --version        Displays current xdice version

        

        CONTRIBUTION

        ^^^^^^^^^^^^

        

        Any opinion / contribution is welcome, please contact us.

        

        TO INSTALL

        ^^^^^^^^^^

        

        ::

        

            pip install xdice

        

        License

        ^^^^^^^

        

        *xdice* is under GNU License

        

        Author

        ^^^^^^

        

        Olivier Massot, 2017, with *Cro-ki Lab*

        

        Tags

        ^^^^

        

        ::

        

            dice roll d20 game random parser dices role board

        

        .. |Build Status| image:: https://travis-ci.org/cro-ki/xdice.svg?branch=master

           :target: https://travis-ci.org/cro-ki/xdice

        .. |Coverage Status| image:: https://coveralls.io/repos/github/cro-ki/xdice/badge.svg?branch=master

           :target: https://coveralls.io/github/cro-ki/xdice?branch=master

        .. |Documentation Status| image:: https://readthedocs.org/projects/xdice/badge/?version=latest

           :target: http://xdice.readthedocs.io/en/latest/?badge=latest

        
Keywords: xdice roll d20 game random parser dices role board
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Other Audience
Classifier: Topic :: Games/Entertainment :: Board Games
Classifier: Topic :: Games/Entertainment :: Role-Playing
Classifier: Topic :: Games/Entertainment :: Multi-User Dungeons (MUD)
Classifier: Topic :: Games/Entertainment :: Turn Based Strategy
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.3
