Metadata-Version: 1.1
Name: CodeStats
Version: 1.0.2
Summary: Wrapper around the Code::Stats API
Home-page: https://www.github.com/niekkeijzer/codestats/
Author: Niek Keijzer
Author-email: info@niekkeijzer.com
License: UNKNOWN
Download-URL: https://github.com/NiekKeijzer/CodeStats/archive/1.0.2.tar.gz
Description: # CodeStats
        
        A simple wrapper around the [codestat][1] API. Currently this wrapper only supports getting information from the API 
        and presenting it in a 'Pythonic' way. Posting new stats to the API is a feature that might be added in the future. 
        
        ## Usage
        
        ```python
        from codestats import User
        
        user = User('niekkeijzer')
        ```
        
        Or if you prefer to call the `load` method yourself, you can disable `auto_load`.
        
        ```python
        from codestats import User
        
        user = User('niekkeijzer', auto_load=False)
        ```
        
        You can also get a single language or machine instance by using the `get` method.
        
        ```python
        from codestats import User
        from codestats.api import Language
        
        user = User('niekkeijzer')
        python = user.get('Python', Language)
        ```
        
        Or by using the shorthands
        
        ```python
        from codestats import User
        
        user = User('niekkeijzer')
        python = user.get_language('python')
        work_pc = user.get_machine('work')
        ```
        
        User, Machine and Language instances each have properties to calculate the level based on the current level as well as 
        the progress to the next level. The formula used to calculate these values is the same as is used by the official 
        [API][2].
        
        ## License
        
        This code is released under the MIT license, see the included LICENSE file for more information.
        
        
        [1]: https://codestats.net/
        [2]: https://github.com/code-stats/code-stats/blob/master/lib/code_stats/xp_calculator.ex
Platform: UNKNOWN
