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.16.tar.gz (15.6 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.16-py3-none-any.whl (24.1 kB view details)

Uploaded Python 3

File details

Details for the file pybeatsaver-0.1.16.tar.gz.

File metadata

  • Download URL: pybeatsaver-0.1.16.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for pybeatsaver-0.1.16.tar.gz
Algorithm Hash digest
SHA256 5618be591e70825a968be3feb255171f18fe6b8ef1d031230558d6c92584b069
MD5 6838fe9a84d939d7f7b06404d82b5e51
BLAKE2b-256 45ba787ad7be256002ceb656182df184d7e8ee93e0775fb207dee1cb83a691e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyBeatSaver-0.1.16-py3-none-any.whl
  • Upload date:
  • Size: 24.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for PyBeatSaver-0.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 d3ad8928fee934ac782e80c26da694d3fc71397b5b3a27398206397937f3cf2d
MD5 673818f136e41a6b3b806a2586f54fc3
BLAKE2b-256 6e6f5e65390d0df0c702762d77fd1226af20030b29d3891360712f30bbbe52ed

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