Mocking SQLAlchemy
==============================

.. toctree::
   :hidden:
   :maxdepth: 1

   about/index
   user_guide/index
   api_reference/index
   contributor_guide/index
   Code of Conduct <codeofconduct>
   license


**************************
mock-alchemy documentation
**************************

**Date**: |today| **Version**: |version|


**Useful links**:
`Binary Installers <https://pypi.org/project/mock-alchemy/>`__ |
`Source Repository <https://github.com/rajivsarvepalli/mock-alchemy>`__ |
`Issues & Ideas <https://github.com/rajivsarvepalli/mock-alchemy/issues>`__

:mod:`mock_alchemy` is an open-source, MIT-licensed library providing a simple method of mocking SQLAlchemy sessions and gives the ability to do sane asserts.

.. raw:: html

    <div class="container">
        <div class="row">
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <!-- Image license and credit -->
                <!-- https://fontawesome.com/license -->
                <img src="_static/index_getting_started.svg" class="card-img-top" alt="about mock-alchemy action icon" height="72" alt="HTML tutorial">
                <div class="card-body flex-fill">
                    <h5 class="card-title">About</h5>
                    <p class="card-text">Curious about <em>mock-alchemy</em>? Check out the about page. There is
                    information about the motivation and usefulness of the <em>mock-alchemy</em> package.</p>

.. container:: custom-button

    :ref:`To the about page<about>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <!-- Image license and credit -->
                <!-- https://fontawesome.com/license -->
                <img src="_static/index_user_guide.svg" class="card-img-top" alt="mock-alchemy user guide action icon" height="72">
                <div class="card-body flex-fill">
                    <h5 class="card-title">User guide</h5>
                    <p class="card-text">The user guide explains the ways to use the mock-alchemy package and
                    also explains some key concepts of mock-alchemy with several examples.</p>

.. container:: custom-button

    :ref:`To the user guide<user_guide>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <!-- Image license and credit -->
                <!-- https://fontawesome.com/license -->
                <img src="_static/index_api.svg" class="card-img-top" alt="api of mock-alchemy action icon" height="72">
                <div class="card-body flex-fill">
                    <h5 class="card-title">API reference</h5>
                    <p class="card-text">The reference guide contains a specific description of
                    the mock-alchemy API. This reference API describes how certain functions work and provides basic examples
                    to illustrate what functions do.</p>

.. container:: custom-button

    :ref:`To the reference guide<api_reference>`

.. raw:: html

                </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                <img src="_static/index_contribute.svg" class="card-img-top" alt="contribute to mock-alchemy action icon" height="72">
                <div class="card-body flex-fill">
                    <h5 class="card-title">Contributor guide</h5>
                    <p class="card-text">Interesed in making improvements to this library? The process for suggesting and making changes is described in more detail here along
                    with the required development dependencies.</p>

.. container:: custom-button

    :ref:`To the contributor guide<contributor_guide>`

.. raw:: html

                </div>
                </div>
            </div>
        </div>
    </div>