Skip to main content

Beat Saver API wrapper

Project description

GitHub license PyPI version codecov PyPI supported Python versions PyPI downloads

PyBeatSaver

Beat Saver 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 beatsaver = BeatSaverAPI(test_mode=True). This will return random data instead of making API requests to Beat Saver.

Usage:

import asyncio
from pybeatsaver import BeatSaverAPI, BeatSaver


async def main():
    async with BeatSaverAPI() as beatsaver:
        beatmap = await beatsaver.beatmap("16d22")
        print(beatmap)

# Without "async with" syntax
async def main2():
    beatsaver = BeatSaver()
    await beatsaver.start()

    beatmap = await beatsaver.beatmap("16d22")
    print(beatmap)

# Get fake data instead
async def main_fake():
    async with BeatSaverAPI(test_mode=True) as beatsaver:
        beatmap = await beatsaver.beatmap("16d22")
        print(beatmap)

asyncio.run(main())
asyncio.run(main2())
asyncio.run(main_fake())

Faker provider:

from faker import Faker
from pybeatsaver import BeatSaverProvider


faker = Faker()
faker.add_provider(BeatSaverProvider)

beatmap = faker.map_detail()
print(beatmap)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyBeatSaver-0.1.10.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

PyBeatSaver-0.1.10-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file PyBeatSaver-0.1.10.tar.gz.

File metadata

  • Download URL: PyBeatSaver-0.1.10.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for PyBeatSaver-0.1.10.tar.gz
Algorithm Hash digest
SHA256 76b25d6df9327accabe64573f5fd4f5a1f9bc1fefbce3ee31986313e4f4fd56d
MD5 de13c7f28a71dbe163c0672256ebebe5
BLAKE2b-256 dfef7ff30890b426174cf425e695f7d731fe638fc64d37d27ea5b9a35caaff49

See more details on using hashes here.

File details

Details for the file PyBeatSaver-0.1.10-py3-none-any.whl.

File metadata

  • Download URL: PyBeatSaver-0.1.10-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for PyBeatSaver-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 8e79a701c45ba2d7faa867942b94ff742309a673829d55c65320bc3a9a7b79a1
MD5 e455395e9a4b6698415b67e78124d4d5
BLAKE2b-256 d9e95ba8af962a01b5f7bebceeaabf6faa07add4c4f43956bf94d7082d2b8e6d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page