Skip to main content

Read-only Python wrapper around blaseball game API

Project description

blaseball-mike

Totally not a microphone to the blaseball API

This is a python wrapper over blaseball's public APIs, including player/team/game fetches, as well as deserialization of the event stream.

Installation

pip install blaseball-mike

Docs

Full API documentation can be found at https://jmaliksi.github.io/blaseball-mike/

Example Usage

>>> from blaseball_mike.models import Team
>>> fridays = Team.load_by_name('fridays')
>>> [player.name for player in fridays.lineup]
['Elijah Valenzuela', 'Juice Collins', 'York Silk', 'Baldwin Breadwinner', 'Terrell Bradley', 'Sixpack Dogwalker', 'Fletcher Yamamoto', 'Bevan Underbuck', 'Christian Combs']

Nested objects will autoload when iterated over. Attributes match the names found in the official Blaseball API, just in snake case. Derived spec can be found here: https://github.com/Society-for-Internet-Blaseball-Research/blaseball-api-spec

Supported objects are:

  • Team
  • GlobalEvent
  • Player
  • Division
  • Subleague
  • League
  • Game
  • Simulated

Simulated stlats

If you want to see how a decree/blessing may shake out, you can make a simulated copy of a player with modified stats.

>>> york = Player.load_one('86d4e22b-f107-4bcf-9625-32d387fcb521')
>>> yorks = [york.simulated_copy(multipliers={'overall_rating': n/100.0}) for n in range(1, 10)]
>>> [y.batting_rating for y in yorks]
[0.9823391734764451, 0.991192294100704, 1.000038548392815, 1.0088780122143204, 1.0177107598404203, 1.026536864008585, 1.0353563959652192, 1.0441694255104683, 1.0529760210412604]

Find player by name

This hooks into the blaseball-reference API for reverse name lookup (relatively slow, please be gentle)

>>> kiki = Player.find_by_name('Kiki Familia')
>>> kiki.name
'Kiki Familia'

stlats viewer CLI

>>> from blaseball_mike.utils import print_stlats
>>> fridays = Team.load_by_name('fridays')
>>> print_stlats(*fridays.rotation)
name        base  cont  grou  indu  lase  divi  mart  moxi  musc  path  thwa  trag  anti  chas  omni  tena  watc  cold  over  ruth  shak  unth  cinn  dece  pean  pres  soul  tota
Bevan Unde  0.91  0.74  0.81  0.57  0.81  0.22  0.76  0.61  0.11  0.01  0.11  0.10  0.21  0.38  0.59  0.97  0.70  0.42  0.34  0.15  0.93  0.50  0.56  0.00  1.00  0.20  6.00  13.00
Stevenson   0.97  0.23  0.38  0.57  0.85  0.88  0.28  0.17  0.42  0.20  0.52  0.10  1.04  0.65  0.16  0.97  0.80  0.40  0.36  0.83  0.08  0.42  0.67  0.00  1.00  0.47  4.00  12.00
James Mora  0.80  0.41  0.33  0.66  0.11  0.36  0.86  0.49  0.76  0.10  0.92  0.10  0.51  0.57  0.69  0.46  1.08  0.09  0.59  0.52  0.12  0.23  0.18  0.00  1.00  0.54  3.00  12.00
Sixpack Do  0.98  0.10  0.92  0.18  0.03  0.55  0.24  0.75  0.89  0.90  0.66  0.10  0.89  0.18  0.69  0.43  0.55  0.78  0.78  0.46  0.09  0.55  0.89  0.00  0.00  0.60  4.00  12.00
Evelton Mc  0.38  0.48  0.34  0.10  0.43  0.16  0.42  0.04  0.15  0.69  0.16  0.10  0.20  1.14  0.56  0.64  0.19  0.99  0.85  0.65  0.17  0.12  0.88  0.00  1.00  0.81  4.00  12.00

Current day

>>> from blaseball_mike.models import SimulationData
>>> sim = SimulationData.load()
>>> sim.day
71

Development

macOS/unix setup:

python3 -m venv env
source env/bin/activate
pip install -r requirements.txt

Publishing to pypi

Automatic (recommended)

  1. Bump version in setup.py. Use [https://semver.org/ semver], ie fixes are a patch, new features are a minor, and breaking changes are a major.
  2. Draft new release
  3. Name new tag with the version in setup.py. Add useful description.
  4. Publishing will automatically kick off a github action to publish

Manual (use in case something goes wrong with auto publish)

  1. Bump version in setup.py. Use [https://semver.org/ semver], ie fixes are a patch, new features are a minor, and breaking changes are a major.
  2. Delete dist/* and build/*
  3. python3 setup.py sdist bdist_wheel
  4. python3 -m twine upload -r pypi dist/*

Documentation

Use triple quotes to add docstrings to any public method and class. Docs will be built and deployed on merges to main.

Manual build

  1. pip install pdoc3
  2. pdoc --html blaseball_mike --force -o docs

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

blaseball-mike-5.13.1.tar.gz (65.0 kB view details)

Uploaded Source

Built Distribution

blaseball_mike-5.13.1-py3-none-any.whl (81.3 kB view details)

Uploaded Python 3

File details

Details for the file blaseball-mike-5.13.1.tar.gz.

File metadata

  • Download URL: blaseball-mike-5.13.1.tar.gz
  • Upload date:
  • Size: 65.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for blaseball-mike-5.13.1.tar.gz
Algorithm Hash digest
SHA256 64a115d57b69edb5ce911c8e73f227792188c9abed1f88da7b5c3accfea4d8ce
MD5 6d9ddb32ff3c92bf7aeeb2d0cd0e5144
BLAKE2b-256 6dafb6141a2d140b9dd4fd684559f1a2548fd08ab136c37b5bd1d1b9631c69cf

See more details on using hashes here.

Provenance

File details

Details for the file blaseball_mike-5.13.1-py3-none-any.whl.

File metadata

  • Download URL: blaseball_mike-5.13.1-py3-none-any.whl
  • Upload date:
  • Size: 81.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for blaseball_mike-5.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a01482cc94dd67b1a90e63598275475cddcc57bfb3fce9b42470c23521087bba
MD5 8153fc57e5ee0f2774dbef935acba7dc
BLAKE2b-256 615cc5f41e994b7809e594a6d3d21af6c65828de44e871d60608651119e18be3

See more details on using hashes here.

Provenance

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