Skip to main content

BSDotPy, A module to get a bombsquad player's account data.

Project description

BSDotPy

BSDotPy, A module to get a bombsquad player's account data from bombsquad's servers.

Badges

Provided By: shields.io

PyPI Version PyPI Downloads Apache License 2.0 Connect On Discord Code Lines Code Size Pull Requests Issues Contributors

Acknowledgements

Authors

Installation

Easiest way is to install bsdotpy with pip

  pip install -U bsdotpy

Usage / Examples

As mentioned in the bombsquad's server builds, you might need to show stats of the players playing in your server's website, instead of using http://bombsquadgame.com/accountquery?id={YOUR_UNIQUE_ID} api and manually reformating the data, you can use this api wrapper to do everything for you automatically. Currently, the below four parameters are returned by API.

To get your account id, enter 'getaccountid' in BombSquad Application's Settings -> Advanced -> Enter Code.

from bsdotpy import BombSquadServer

server = BombSquadServer() # Instantiates a BombSquadServer object which will interact with bombsquad's server.

unique_id = "pb-IF4rVEQCKg==" # Unique ID must be valid else an error will be thrown
player = server.get_player_data(unique_id) # Returns a bsdotpy.BombSquadPlayer object

print(player.name) # Prints the player's name returned by bombsquad server's api
>>> '꧁༒Firͥe Heͣaͫd༒꧂'

print(player.unique_id) # Prints unique id of the player
>>> 'pb-IF4rVEQCKg=='

print(player.icon_url) # Prints the url to the icon the player has
>>> 'http://bombsquadgame.com/img/char/30.png'

print(player.created_at) # Prints a datetime.datetime object of when the player was created
>>> 2020-02-17 17:10:50

print(repr(player))  # Prints the class object representation of the BombSquadPlayer object
>>> <BombSquadPlayer unique_id='pb-IF4rVEQCKg==', name='꧁༒Firͥe Heͣaͫd༒꧂', icon_url='http://bombsquadgame.com/img/char/30.png', created_at='2020-02-17 17:10:50'>

Contributing

Contributions are always welcome!

  • Fork this repository.
  • Make the changes in your forked repositry.
  • Make sure to fetch upstream before generating a PR.
  • Generate a pull request.

Please adhere to the GitHub's code of conduct for contributions and contributors.

License

Apache License 2.0

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

bsdotpy-0.1.2-py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 3

Supported by

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