.. Simple Python CRUD Tool documentation master file, created by
   sphinx-quickstart on Thu Apr 20 12:57:26 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Simple Python CRUD Tool
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


.. warning:: Current implementation only supports ***Postgres, MysQL, SQLite***, but support for all other **major RDBMS** will follow soon.


Overview
+++++++++++++

`Web based DB CRUD application` with intuitive UI for all CRUD feature along with below addons:

* Auto **discovery** of tables from database schema. Also allow not to list specific table using patterns.
* Granular column based **search** capability.
* CSV based **download** of data.
* CSV based asynchronous **bulk insert**.
* **Audit** for all operation with change tracking capability.
* **Authentication** and new user registration support.
* Role based **authorization** to specific operations.
* Email based **notification** support for specific operations.


Installation
+++++++++++++

Steps for quick start and complex deployments are documented at `LINK <installation.html>`_


Configuration
+++++++++++++

Detail process to configure the application is documented at `LINK <configuration.html>`_

.. note:: Before you start the application after installation you **will need** to configure it, with no configuration you can do nothing.


Usage
+++++++++++++

You can also have a look on the usage guide, specially the basic walk through at `LINK <usage.html>`_


Bug Report and Support
+++++++++++++

Use GitHub issue tracking system for issues, check out details at this `LINK <https://docs.github.com/en/issues/tracking-your-work-with-issues>`_


Contribute
+++++++++++++

We'd love to get contributions from you! So start making your pull request. `DETAILS <contribution.html>`_




.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
