Metadata-Version: 2.1
Name: warhammer-stats
Version: 0.0.7
Summary: Warhammer 40k stats tools
Home-page: https://github.com/akabbeke/warhammer_stats
Author: Adam Kabbeke
Author-email: akabbeke@gmail.com
License: UNKNOWN
Description: # Warhammer Stats
        This is a Python library providing components to generate PMFs for Warhammer 40000. This code was taken from the backend of https://www.warhammer-stats-engine.com/ and split out into its own package to make is easier for other developers to use.
        
        # Usage
        You can use pip to fetch the latest version of the library. https://pypi.org/project/warhammer-stats/
        
        `pipenv install warhammer-stats`
        
        # Example Usage
        ```python
        
        from warhammer_stats import Attack, Weapon, Target, PMFCollection
        from warhammer_stats.modifiers import ModifierCollection, ReRollOnes
        
        # Define a re-roll ones weapon modifier
        weapon_mods = ModifierCollection(hit_mods=[ReRollOnes()])
        
        # Define the weapon. In this case it is a clasic boltgun hitting on a 4+
        weapon = Weapon(
            bs=4,
            shots=PMFCollection.static(10),
            strength=4,
            ap=0,
            damage=PMFCollection.static(1),
            modifiers=weapon_mods
        )
        
        # Define the target. In this case it is a space marine
        target = Target(
            toughness=4,
            save=3,
            invuln=7,
            fnp=7,
            wounds=1
        )
        
        # Create an attack
        attack = Attack(weapon, target)
        
        # Run the calculation
        result = attack.run()
        
        # print the mean of the damage distribution
        print(f'Average wounds: {result.damage_dist.mean()}')
        
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
