<commit_before>How do I use it?
================

Using beekeeper is pretty simple, but because it can work with almost
any RESTful API, it's also a little tricky to describe. Let's take
a hypothetical API, for FooBar Ventures.

FooBar Ventures is in the business of widget manufacturing; their
API provides tools to help their customers know what kinds of widgets
are available, and gives detailed information about them. Each widget
is compatible with a variety of products from other vendors, and FooBar
Ventures also maintains a list of compatible products which can be accessed
via the API.

First, we'll need to import beekeeper and initialize the FooBar Ventures API:

.. code:: python

    >>> from beeekeeper import API
    
    >>> fbv = API.from_domain('foobar.com')

Then, let's say we want to get a list of all the widgets that FooBar
makes:

.. code:: python
<commit_msg>Update how_to_use.rst<commit_after>How do I use it?
================

Using beekeeper is pretty simple, but because it can work with almost
any RESTful API, it's also a little tricky to describe. Let's take
a hypothetical API, for FooBar Ventures.

FooBar Ventures is in the business of widget manufacturing; their
API provides tools to help their customers know what kinds of widgets
are available, and gives detailed information about them. Each widget
is compatible with a variety of products from other vendors, and FooBar
Ventures also maintains a list of compatible products which can be accessed
via the API.

First, we'll need to import beekeeper and initialize the FooBar Ventures API:

.. code:: python

    >>> from beekeeper import API
    
    >>> fbv = API.from_domain('foobar.com')

Then, let's say we want to get a list of all the widgets that FooBar
makes:

.. code:: python

{'fraction_non_alphanumeric': 0.06696679797411367, 'fraction_numerical': 0.0, 'mean_word_length': 4.244837758112094, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 15, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, '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': '4196495', 'n_tokens_mistral': 497, 'n_tokens_neox': 452, 'n_words': 265}