<commit_before>.. currentmodule:: rocket_snake

API Reference
*************

The following section outlines the API of Rocket Snake.

The Client
==========

.. autoclass:: RLS_Client
    :members:

The Exceptions
==============



The Constants
=============

.. module:: rocket_snake.constants

This module defines constants that are used when requesting information from the API.<commit_msg>Add documentation for the custom exceptions<commit_after>.. currentmodule:: rocket_snake

API Reference
*************

The following section outlines the API of Rocket Snake.

The Client
==========

.. autoclass:: RLS_Client
    :members:

The Exceptions
==============

.. module:: rocket_snake.exceptions

This module (``rocket_snake.exceptions``) defines the exceptions that are specific to Rocket Snake.
All of them are subclasses of some ``builtins`` exception, but not all of them are direct subclasses.

.. autoclass:: NoAPIKeyError
    :members:

.. autoclass:: APIServerError
    :members:

.. autoclass:: APINotFoundError
    :members:

.. autoclass:: APIBadResponseCodeError
    :members:

.. autoclass:: RatelimitError
    :members:

.. autoclass:: InvalidAPIKeyError
    :members:


The Constants
=============

.. module:: rocket_snake.constants

This module (``rocket_snake.constants``) defines constants that are used when requesting information from the API.
{'fraction_non_alphanumeric': 0.1476608187134503, 'fraction_numerical': 0.0, 'mean_word_length': 4.587755102040816, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '611670', 'n_tokens_mistral': 398, 'n_tokens_neox': 374, 'n_words': 130}