.. _f-filestorefastapi:

module ``server.filestore_fastapi``
===================================





.. inheritance-diagram:: pyquickhelper.server.filestore_fastapi


Short summary
+++++++++++++

module ``pyquickhelper.server.filestore_fastapi``

Simple class to store and retrieve files through an API.


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------+-------------------------+
| class                                                           | truncated documentation |
+=================================================================+=========================+
| :class:`Item <pyquickhelper.server.filestore_fastapi.Item>`     |                         |
+-----------------------------------------------------------------+-------------------------+
| :class:`Metric <pyquickhelper.server.filestore_fastapi.Metric>` |                         |
+-----------------------------------------------------------------+-------------------------+
| :class:`Query <pyquickhelper.server.filestore_fastapi.Query>`   |                         |
+-----------------------------------------------------------------+-------------------------+
| :class:`QueryL <pyquickhelper.server.filestore_fastapi.QueryL>` |                         |
+-----------------------------------------------------------------+-------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| function                                                                                 | truncated documentation                                                                                                    |
+==========================================================================================+============================================================================================================================+
| :func:`_get_password <pyquickhelper.server.filestore_fastapi._get_password>`             |                                                                                                                            |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`_post_request <pyquickhelper.server.filestore_fastapi._post_request>`             |                                                                                                                            |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`create_app <pyquickhelper.server.filestore_fastapi.create_app>`                   | Creates an instance of application class returned by :func:`create_fast_api_app`. It checks that environment variables ... |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`create_fast_api_app <pyquickhelper.server.filestore_fastapi.create_fast_api_app>` | Creates a :epkg:`REST` application based on :epkg:`FastAPI`.                                                               |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`fast_api_content <pyquickhelper.server.filestore_fastapi.fast_api_content>`       | Retrieves the dataframes based on partial information. Enumerates a list of dataframes.                                    |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`fast_api_query <pyquickhelper.server.filestore_fastapi.fast_api_query>`           | Retrieves the list of dataframe based on partial information.                                                              |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+
| :func:`fast_api_submit <pyquickhelper.server.filestore_fastapi.fast_api_submit>`         | Stores a dataframe into a local stores.                                                                                    |
+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: pyquickhelper.server.filestore_fastapi
    :members:
    :special-members: __init__
    :show-inheritance: