<commit_before>.. image:: https://img.shields.io/travis/steveYeah/PyBomb.svg?branch=master
   :target: https://travis-ci.org/steveYeah/PyBomb

PyBomb
==============

.. pull-quote::
  Simple clients for the Giant Bomb API.
  http://www.giantbomb.com/api/

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

**Currently Supported Resources**:

* games
* game

Install
-------

.. code-block:: shell

   pip install pybomb


Examples
--------
**GamesClient - search**

.. code-block::

   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**

.. code-block::

  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

More examples for other clients can be found in the documentation
https://pybomb.readthedocs.org

To see a working example of Pybomb, take a look at the example project GameSearch
https://github.com/steveYeah/gamesearch
<commit_msg>slight clean up of README<commit_after>.. image:: https://img.shields.io/travis/steveYeah/PyBomb.svg?branch=master
   :target: https://travis-ci.org/steveYeah/PyBomb

PyBomb
==============

.. pull-quote::
  Simple clients for the Giant Bomb API.
  http://www.giantbomb.com/api/

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

**Currently Supported Resources**:

* games
* game

Install
-------

.. code-block:: shell

   pip install pybomb


Examples
--------
**GamesClient - search**

.. code-block::

   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**

.. code-block::

  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

**More examples**

To see a working example of Pybomb, take a look at the example project GameSearch
https://github.com/steveYeah/gamesearch

Documentation
-------------
The full documentation, including more examples can be found at https://pybomb.readthedocs.org

{'fraction_non_alphanumeric': 0.1149223101729698, 'fraction_numerical': 0.004104368220463207, 'mean_word_length': 3.408268733850129, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1289719', 'n_tokens_mistral': 1171, 'n_tokens_neox': 1130, 'n_words': 264}