|
|
@@ -1,87 +1,130 @@
|
|
|
Metadata-Version: 1.2
|
|
|
Name: xdice
|
|
|
-Version: 1.0.0
|
|
|
-Summary: Lightweight python library for managing xdice, scores, and xdice-notation patterns.
|
|
|
+Version: 1.1.3
|
|
|
+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: **xdice**
|
|
|
+Description: |Build Status| |Coverage Status| |Documentation Status|
|
|
|
|
|
|
- *xdice* is a lightweight python library for managing dice, scores, and dice-notation patterns.
|
|
|
+ **xdice**
|
|
|
|
|
|
- It allows to easily interpret literal expressions as rolls of dice ('1d6', '3d4+3', '12d6+1d4'...etc.), then manipulate the results.
|
|
|
+ *xdice* is a lightweight python library for managing dice, scores, and
|
|
|
+ dice-notation patterns.
|
|
|
|
|
|
- #### Python Versions
|
|
|
+ - Parse almost any Dice Notation pattern: '1d6+1', 'd20', '3d%', '1d20//2 - 2*(6d6+2)', 'max(1d4+1,1d6)', '3D6L2', 'R3(1d6+1)'...etc.
|
|
|
+ - API help you to easily manipulate dices, patterns, and scores as objects
|
|
|
+ - A command line tool for convenience
|
|
|
|
|
|
- DiceRollParser has been tested with python 3.3+
|
|
|
|
|
|
- ### Documentation
|
|
|
+ Python Versions
|
|
|
+ ^^^^^^^^^^^^^^^
|
|
|
|
|
|
- See the **[full documentation](https://xdice.readthedocs.io/en/latest/)**
|
|
|
+ DiceRollParser has been tested with **python 3.3+**
|
|
|
|
|
|
- #### Examples:
|
|
|
+ Documentation
|
|
|
+ ~~~~~~~~~~~~~
|
|
|
|
|
|
- import dice
|
|
|
+ For more, see the Documentation_
|
|
|
|
|
|
- ## 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
|
|
|
+ Examples:
|
|
|
+ ^^^^^^^^^
|
|
|
|
|
|
- # Parse patterns with **roll()**
|
|
|
-
|
|
|
- ps = roll("2d6+18")
|
|
|
-
|
|
|
- print( ps, ps.format() )
|
|
|
- >> 28 '[5,6]+18'
|
|
|
+ ::
|
|
|
|
|
|
+ import dice
|
|
|
|
|
|
- #### CLI
|
|
|
+ # Roll simple dices with **rolldice()**
|
|
|
|
|
|
- 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
|
|
|
+ score = rolldice(6, amount=2)
|
|
|
|
|
|
+ # manipulates score as an integer
|
|
|
|
|
|
- #### CONTRIBUTION
|
|
|
+ print(score)
|
|
|
+ >> 11
|
|
|
+ print(score * 2)
|
|
|
+ >> 22
|
|
|
+ print(score == 11)
|
|
|
+ >> True
|
|
|
+
|
|
|
+ # Or iterates over the results
|
|
|
+
|
|
|
+ for result in score:
|
|
|
+ print(result)
|
|
|
+ >> 5
|
|
|
+ >> 6
|
|
|
+
|
|
|
+ # Parse patterns with **roll()**
|
|
|
+
|
|
|
+ ps = roll("2d6+18")
|
|
|
+
|
|
|
+ print(ps)
|
|
|
+ >> 28
|
|
|
+ print(ps.format())
|
|
|
+ >> '[5,6]+18'
|
|
|
+
|
|
|
+ ps = roll("6D%L2")
|
|
|
+
|
|
|
+ print(ps)
|
|
|
+ >> 315
|
|
|
+ print(ps.format(verbose=True))
|
|
|
+ >> '6D%L2(scores:[80, 70, 76, 89], dropped:[2, 49])'
|
|
|
+
|
|
|
+
|
|
|
+ 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
|
|
|
+ TO INSTALL
|
|
|
+ ^^^^^^^^^^
|
|
|
|
|
|
- pip install xdice
|
|
|
+ ::
|
|
|
|
|
|
- #### License
|
|
|
+ pip install xdice
|
|
|
+
|
|
|
+ License
|
|
|
+ ^^^^^^^
|
|
|
|
|
|
*xdice* is under GNU License
|
|
|
|
|
|
- #### Author
|
|
|
+ Author
|
|
|
+ ^^^^^^
|
|
|
|
|
|
Olivier Massot, 2017, with *Cro-ki Lab*
|
|
|
|
|
|
- #### Tags
|
|
|
+ Tags
|
|
|
+ ^^^^
|
|
|
+
|
|
|
+ ::
|
|
|
+
|
|
|
+ dice roll d20 game random parser dices role board
|
|
|
+
|
|
|
+ .. _Documentation: https://xdice.readthedocs.io/en/latest/
|
|
|
|
|
|
- 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
|
olinox