Metadata-Version: 2.1
Name: rankade.py
Version: 0.1.2
Summary: Unofficial Python async wrapper for the Rankade API
Author-email: Calum Crawford <c@calumcrawford.com>
License: MIT License
        
        Copyright (c) 2021–present 14zombies
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Changelog, https://github.com/14zombies/Rankade.py/blob/master/CHANGELOG.md
Project-URL: Documentation, https://calumcrawford.com/rankadepy
Project-URL: Homepage, https://calumcrawford.com/rankadepy
Project-URL: Issues, https://github.com/14zombies/Rankade.py/issues
Project-URL: Repository, https://github.com/14zombies/Rankade.py.git
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Provides-Extra: all
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: tests
License-File: LICENSE

# Rankade.py
> Unofficial Python async wrapper for the Rankade API.

## Installation
### pip
```zsh
pip3 install rankade.py
```

## Usage
### Access the Rankade API
- Select the group on Rankade you wish to use.
- From the "Group Manager" screen select "APIs".
  ![Rankade Group Manager Modal](docs/_static/images/rankade_group_manager.png)
- This should bring you to the "Credentials and status" page.
- Copy your key.
- Generate a secret.

### Sample Project
```python
import asyncio
import rankade

async def main():
    rankade = rankade.Rankade(key="rankade-key", secret="rankade-secret")
    result = rankade.get_games()
    print(result)

if __name__ == '__main__'
    asyncio.run(main())
```

### Examples
See [Documentation](https://calumcrawford.com/rankadepy/examples) or [Examples](https://github.com/14zombies/rankade.py/tree/main/examples) for more.

## Documentation
> [Documentation](https://calumcrawford.com/rankadepy)

