Metadata-Version: 2.1
Name: wotreplay
Version: 1.0.0
Summary: World of Tanks PC replay data extractor
Home-page: https://gitlab.com/gabriel_oana/worldoftanks
Author: Gabriel Oana
Author-email: gabriel.oana91@gmail.com
License: MIT
Description: [![pipeline status](https://gitlab.com/gabriel_oana/wotreplay/badges/master/pipeline.svg)](https://gitlab.com/gabriel_oana/wotreplay)
        [![pipeline status](https://gitlab.com/gabriel_oana/wotreplay/badges/master/coverage.svg)](https://gitlab.com/gabriel_oana/wotreplay)
        [![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/wotreplay)](https://pypistats.org/packages/wotreplay)
        ![PyPI](https://img.shields.io/pypi/v/wotreplay)
        ![PyPI - Status](https://img.shields.io/pypi/status/wotreplay)
        
        # World of Tanks - Replay data extract
        
        ### 1. Description
        The package can extract only the metrics data from World of Tanks replays. 
        It does not access any data such as tank positions or chat. 
        
        Data can be extracted only from replays in which the player has waited until the end of the battle. If the player has 
        quit the battle after dying and the battle was not ended, then only the battle metadata is available (which does not 
        contain any battle performance / credits / xp data).
        
        The replays should be set to be "all" collected and not "last" one recorded. 
        
        All data extracted can be saved to a local sqlite database. 
        ### 2. Usage
        ```
        pip install wotreplay
        ```
        
        The package provides the possibility of exploring the data contained within one replay or process all replays in a 
        directory and store the data in a local database.
        
        ```
        from wotreplay import ReplayData
        replay = ReplayData(file_path='path_to_replay/replay_file.wotreplay',
                             db_path='', db_name='', load=False)
        
        print(replay.battle_metadata)
        print(replay.battle_performance)
        print(replay.common)
        print(replay.battle_frags)
        print(replay.battle_economy)
        print(replay.battle_xp)
        ```
        
        Process all the replay files and store the results in the database
        
        ```
        from wotreplay import ProcessReplays
        
        ProcessReplays.process_all(replay_dir='/path/to/replay/dir', 
                                   db_path='path/where/to/save/the/database, 
                                   db_name='wotreplay')
        ```
        This will process the replays sequentially. 
        
        <u>Note:</u> Once a replay has been processed and added to the database, it will not be processed again to avoid data 
        duplication.
        
        ### 3. Compatibility
        The replays from the following client versions have been tested. 
        
        | Client Version        | Passed    |                      
        | ---                   | ---       |
        | 0.9.21                | True      |
        | 0.9.22                | True      |
        | 1.0.0                 | True      |
        | 1.0.1                 | True      |
        | 1.0.2                 | True      |
        | 1.1.0                 | True      |
        | 1.2.0                 | True      |
        | 1.3.0                 | True      |
        | 1.4.0                 | True      |
        | 1.4.1                 | True      |
        | 1.5.0                 | True      |
        | 1.5.1                 | True      |
        | 1.6.1                 | True      |
        | 1.7.0                 | True      |
        | 1.7.1                 | True      |
        | 1.8.0                 | True      |
        | 1.9.0                 | True      |
        
        No replays before 0.9.21 have been tested due to lack of replays available. 
        
        ### 4. Data Taxonomy
        Examples of data retrieved: 
        
        * Battle metadata: [Battle Metadata Fields](https://gitlab.com/gabriel_oana/wotreplay/-/blob/master/taxonomy/battle_metadata.json)
        * Battle performance: [Battle Performance Fields](https://gitlab.com/gabriel_oana/wotreplay/-/blob/master/taxonomy/battle_performance.json)
        * Common: [Common Data Fields](https://gitlab.com/gabriel_oana/wotreplay/-/blob/master/taxonomy/common.json)
        * Battle frags: [Battle Frags Fields](https://gitlab.com/gabriel_oana/wotreplay/-/blob/master/taxonomy/battle_frags.json)
        * Battle economy: [Battle Economy Fields](https://gitlab.com/gabriel_oana/wotreplay/-/blob/master/taxonomy/battle_economy.json)
        * Battle xp: [Battle XP Fields](https://gitlab.com/gabriel_oana/wotreplay/-/blob/master/taxonomy/battle_xp.json)
        
        ### 5.Access and rights
        If you are using this on any online tools please give the appropriate credit.    
        
        ### 6.To Do
        The extraction of data from replays is more or less complete. 
        There are a few features to be created in the future to create the aliases of tank names and maps. 
        
        ### 7. Development
        
        ##### Unittesting
        For development purposes, the unittests can be executed via: 
        
        ```
        python3 -m unittest discover -v worldoftanks/tests
        ```
        
        ##### Coverage Tests
        
        ```
        coverage run --source=worldoftanks -m unittest discover -s worldoftanks/tests
        coverage report -m
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
