https://github.com/kiyomi-parents/pyscoresaber

Score Saber API wrapper
https://github.com/kiyomi-parents/pyscoresaber

async python python-3 scoresaber scoresaber-api

Last synced: 3 months ago
JSON representation

Score Saber API wrapper

• Host: GitHub
• URL: https://github.com/kiyomi-parents/pyscoresaber
• Owner: Kiyomi-Parents
• License: mit
• Created: 2021-08-03T02:06:27.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-06-01T08:57:44.000Z (over 1 year ago)
• Last Synced: 2024-10-16T02:04:22.645Z (3 months ago)
• Topics: async, python, python-3, scoresaber, scoresaber-api
• Language: Python
• Homepage:
• Size: 142 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub license](https://img.shields.io/github/license/Kiyomi-Parents/PyScoreSaber)](https://github.com/Kiyomi-Parents/PyScoreSaber/blob/master/LICENSE)

[![PyPI version](https://badge.fury.io/py/PyScoreSaber.svg)](https://pypi.org/project/PyScoreSaber)

[![codecov](https://codecov.io/gh/Kiyomi-Parents/PyScoreSaber/branch/master/graph/badge.svg?token=X2LFJL839M)](https://codecov.io/gh/Kiyomi-Parents/PyScoreSaber)

[![PyPI supported Python versions](https://img.shields.io/pypi/pyversions/pyscoresaber.svg)](https://pypi.org/project/PyScoreSaber)

[![PyPI downloads](https://img.shields.io/pypi/dm/pyscoresaber?color=blueviolet&logo=pypi)](https://pypi.org/project/PyScoreSaber)

# PyScoreSaber

Score Saber API wrapper

### Features

* Rate Limit handling

* Query Caching

* Everything is ``async``

* Additional helper methods and async generators

* Faker data provider

The faker data mode can be activated with the following ```scoresaber = ScoreSaber(test_mode=True)```.

This will return random data instead of making API requests to Score Saber.

### Usage:

```python

import asyncio

from pyscoresaber import ScoreSaberAPI

async def main():

    async with ScoreSaberAPI() as scoresaber:

        player = await scoresaber.player_full("76561198029447509")

        print(player)

# Get fake data instead

async def main_fake():

    async with ScoreSaberAPI(test_mode=True) as scoresaber:

        player = await scoresaber.player_basic("76561198029447509")

        print(player)

asyncio.run(main())

asyncio.run(main_fake())

```

### Faker provider:

```python

from faker import Faker

from pyscoresaber import ScoreSaberProvider

faker = Faker()

faker.add_provider(ScoreSaberProvider)

player = faker.player_basic("76561198029447509")

print(player)

```