Skip to main content

ko-fi

Tests Coverage Release Drafter TestPyPi Release

Codecov PyPI Read the Docs

PyBomb

This will go into version 1.0 when all resources are supported.

Currently Supported Resources:

  • games
  • game
  • platforms

Support OSS, and me :)

If you find this project useful, please feel free to buy me a coffee

Install

pip install pybomb

Examples

To see a working example of Pybomb, take a look at the example project PyBomb-demo

GamesClient - search

import pybomb

my_key = your_giant_bomb_api_key
games_client = pybomb.GamesClient(my_key)

return_fields = ('id', 'name', 'platforms')
limit = 10
offset = 5
sort_by = 'name'
filter_by = {'platforms': pybomb.PS3}

response = games_client.search(
   filter_by=filter_by,
   return_fields=return_fields,
   sort_by=sort_by,
   desc=True,
   limit=limit,
   offset=offset
)

print response.results
print response.uri
print response.num_page_results
print response.num_total_results

GamesClient - quick_search

import pybomb

my_key = your_giant_bomb_api_key
games_client = pybomb.GamesClient(my_key)

response = games_client.quick_search(
  name='call of duty',
  platform=pybomb.PS3,
  sort_by='original_release_date',
  desc=True
)

print response.results
print response.uri
print response.num_page_results
print response.num_total_results

Documentation

The full documentation, including more examples can be found at readthedocs

Contributing

This project uses Poetry and Nox so make sure you have those setup!

Whilst working you can use

$ nox -rs tests

to run the tests, but once you have finished, make sure to run all of nox before making a PR

$ nox

This project also uses Pytest for tests, and we aim for 100% test coverage. The build will fail when the coverage is less than this, but feel free to use # pragma: no cover if it makes sense to do so (although this should be very rare). Mypy is also used, and we even use typeguard so typing is important here!

I am always happy to help where I can and I try to be as responsive as possible to PRs. Email me if I am slow, or if you need any help!

Metadata

Release files for pybomb 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pybomb 0.4.0
File Size Uploaded Provenance
pybomb-0.4.0.tar.gz 9.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for pybomb 0.4.0
File Interpreter ABI Platform
pybomb-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 21.9 kB

Release files / pybomb-0.4.0.tar.gz

Download URL pybomb-0.4.0.tar.gz
Size 9.5 kB
Tags Source
SHA-256 checksum
How to use checksums
54d8fa2a17d127207b7781b945b2bb2d1bade8bc4fb3c7349aeaf73bf26c3389
BLAKE2b-256 checksum
How to use checksums
41957e63f3ae8f3d7310cf9ac419d4caadb5fb92699547accf3ce7de176423a5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.9 CPython/3.8.11 Linux/5.8.0-1041-azure

Release files / pybomb-0.4.0-py3-none-any.whl

Download URL pybomb-0.4.0-py3-none-any.whl
Size 12.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
32e0c717eba3eb61b87eaf6e0b89db141a3c742a98d4210d846180f283298d49
BLAKE2b-256 checksum
How to use checksums
55a807d040504dd001c01546405beeecd506bdb25c3f4665e992f3ac10a8348e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.9 CPython/3.8.11 Linux/5.8.0-1041-azure

Security for pybomb 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page