Metadata-Version: 2.1
Name: scoreunlocked
Version: 0.0.2
Summary: A simple package for using the ScoreUnlocked leaderboard system running at scoreunlocked.pythonanywhere.com
Author-email: Tank King <tankking9833@gmail.com>
License: MIT License
        
        Copyright (c) 2022 Rounak Bhowmik
        
        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: Homepage, https://github.com/tank-king/scoreunlocked
Project-URL: Bug Tracker, https://github.com/tank-king/scoreunlocked/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Package for ScoreUnlocked API

This is a simple package for using the 
[ScoreUnlocked](https://scoreunlocked.pythonanywhere.com) 
Leaderboard System. <br>

If you have not done already, you can click [here](https://scoreunlocked.pythonanywhere.com/users/register)
to create a ScoreUnlocked developer account

You can use this package by installing it from PyPi. To do so, type the following in the terminal:

```commandline
pip install scoreunlocked
```

Once ScoreUnlocked is installed, you can use it as: <br>
```python
import scoreunlocked

client = scoreunlocked.Client()  # instantiating the client
client.connect('developer_name', 'leaderboard_name')

# to get leaderboard from server [returns None if not found or errors occurred]
client.get_leaderboard()

# to post a score to the server
client.post_score(name='name', score=100, validation_data='<data to validate score>') 
```

That's all you need to know for setting up a basic leaderboard.
