Metadata-Version: 2.1
Name: lotery-drawer
Version: 1.0.1
Summary: A simple, proven and non-falsifiable lottery draw tool
Home-page: https://github.com/crypt-online/lotery-drawer
Author: Crypt Online
Author-email: admin@hxrobot.io
License: UNKNOWN
Description: # lotery-drawer
        Lotery-drawer is a simple, proven and non-falsifiable lottery draw tool.
        
        This tool can be used to draw a lotery in a provable way.
        The draw is random but will always return the same result when given the same lotery datas.
        
        ## Documentation
        
        ### Installation
        
          * Python >=3.6 is required to run this program
          * Install the package by running : **pip install lotery-drawer --user**
        
        ### Usage
        
        You can simply print on the console the result of the lotery :
          * Create your own lotery data json, and place it into the **config** directory for exemple.
          * Call the main file with your json path : **python3 main.py "config/dataLotery.json"**
          * Then the console will output the result
        
        
        You can also directly interface your program with the library :
        ```python3
        from lotery_drawer import Drawer
        
        drawer = Drawer()
        result = drawer.draw(dataLotery)
        ```
        
        Here an example of the lotery data json :
        ```json
        {
          "endTimestamp": 1589289392,
          "prizes": [
            {"name":  "1000 HXRO", "nb":  1},
            {"name":  "500 HXRO", "nb":  1},
            {"name":  "200 HXRO", "nb":  5},
            {"name":  "100 HXRO", "nb":  10}
          ],
          "tickets": {
            "player_a": 10,
            "player_b": 20,
            "player_c": 30,
            "player_d": 40,
            "player_e": 150
          }
        }
        ```
          * **endTimestamp**: The end date of the lotery. It is only used to generate a seed for random functions
          * **prizes**: A list of the prizes of the lotery. Each prize can have one or more winning tickets (**nb**) and have a name (**name**)
          * **tickets**: A dict of the tickets at the end of the lotery. Each element of the dict is a player, the number associated is the number of tickets in his possession.
        
        The tool will draw as winning tickets as there is prizes, and return an array containing the usernames and the prizes won.
        Note that if a ticket is won, it is removed from the tickets list for the next prizes.
        
        Here an exemple of the result when using the file **config/dataLotery.json** in the repository :
        ```json
        [
          {"prizeName": "1000 HXRO", "username": "player_e"}, 
          {"prizeName": "500 HXRO", "username": "player_a"}, 
          {"prizeName": "200 HXRO", "username": "player_e"}, 
          {"prizeName": "200 HXRO", "username": "player_e"}, 
          {"prizeName": "200 HXRO", "username": "player_e"}, 
          {"prizeName": "200 HXRO", "username": "player_e"}, 
          {"prizeName": "200 HXRO", "username": "player_d"}, 
          {"prizeName": "100 HXRO", "username": "player_d"}, 
          {"prizeName": "100 HXRO", "username": "player_e"}, 
          {"prizeName": "100 HXRO", "username": "player_d"}, 
          {"prizeName": "100 HXRO", "username": "player_d"}, 
          {"prizeName": "100 HXRO", "username": "player_b"}, 
          {"prizeName": "100 HXRO", "username": "player_e"}, 
          {"prizeName": "100 HXRO", "username": "player_e"}, 
          {"prizeName": "100 HXRO", "username": "player_c"}, 
          {"prizeName": "100 HXRO", "username": "player_c"}, 
          {"prizeName": "100 HXRO", "username": "player_d"}
         ]
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
