<commit_before>############
Introduction
############

``aerospike`` is a package which provides a Python client for
Aerospike database clusters. The Python client is a CPython module, built on
the Aerospike C client.

* :mod:`aerospike` - the module containing the Client, Query, and Scan Classes.

* :ref:`aerospike.scan` is a class built to handle scan operations of entire sets.

* :ref:`aerospike.query` is a class built to handle queries over secondary indexes.

* :mod:`aerospike.predicates` is a submodule containing predicate helpers for use with the Query class.

* :mod:`aerospike.exception` is a submodule containing the exception hierarchy for AerospikeError and its subclasses.

* :mod:`aerospike_helpers` is a helper package for bin operations (list, map, bitwise, etc.), aerospike expressions, batch operations, and complex data type context.

* :ref:`aerospike.geojson` is a class to handle GeoJSON type data.

* :ref:`Data_Mapping` How Python types map to Aerospike Server types.

.. seealso::
    The `Python Client Manual <http://www.aerospike.com/docs/client/python/>`_
    for a quick guide.

Content
#######

.. toctree::
    :maxdepth: 4

    aerospike
    client
    scan
    query
    predicates
    exception
    aerospike_helpers
    geojson
    data_mapping
    key_ordered_dict

Indices and tables
##################<commit_msg>Docs: index: create layout section with tables describing modules and classes<commit_after>############
Introduction
############

``aerospike`` is a package which provides a Python client for
Aerospike database clusters. The Python client is a CPython module, built on
the Aerospike C client.

Layout
======

+----------------------------+------------------------------------------------------------------------+
| Module                     | Description                                                            |
+============================+========================================================================+
| :mod:`aerospike`           | Contains the Client, Query, and Scan Classes.                          |
+----------------------------+------------------------------------------------------------------------+
| :mod:`aerospike.predicates`| Predicate helpers for the Query class.                                 |
+----------------------------+------------------------------------------------------------------------+
| :mod:`aerospike.exception` | Contains the exception hierarchy for AerospikeError and its subclasses.|
+----------------------------+------------------------------------------------------------------------+
| :mod:`aerospike_helpers`   | Bin operations (list, map, bitwise, etc.), \                           |
|                            | Aerospike expressions, \                                               |
|                            | batch operations, \                                                    |
|                            | complex data type context                                              |
+----------------------------+------------------------------------------------------------------------+

The ``aerospike`` module contains these classes:

=========================== ===========
Class                       Description
=========================== ===========
:ref:`aerospike.scan`       Contains scan operations of entire sets.
:ref:`aerospike.query`      Handles queries over secondary indexes.
:ref:`aerospike.geojson`    Handles GeoJSON type data.
:ref:`client`               Aerospike client API
=========================== ===========

In addition, the :ref:`Data_Mapping` page explains how **Python** types map to **Aerospike Server** types.

.. seealso::
    The `Python Client Manual <http://www.aerospike.com/docs/client/python/>`_
    for a quick guide.

Content
#######

.. toctree::
    :maxdepth: 4

    aerospike
    client
    scan
    query
    predicates
    exception
    aerospike_helpers
    geojson
    data_mapping
    key_ordered_dict

Indices and tables
##################
{'fraction_non_alphanumeric': 0.265625, 'fraction_numerical': 0.000496031746031746, 'mean_word_length': 1.6922563417890522, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3338450', 'n_tokens_mistral': 944, 'n_tokens_neox': 874, 'n_words': 305}