FastApp
=======

HTTP Apps Made Easier with FastApp

Installation
------------

.. code-block:: shell

   pip install fastapp

Using Out the Example Server
----------------------------

.. code-block:: shell

   pip install fastapp[example]

.. code-block:: shell

   fastapp serve-debug fastapp.app.example:app

Using FastApp to build an app
-----------------------------

Create a Python File with Endpoints, we'll call this ``main.py``\ :

.. code-block:: python

   from datetime import datetime

   from fastapp.app import app


   @app.get("/hello")
   def custom_endpoint() -> dict:
       """"
       This is a Custom API Endpoint
       """
       return dict(timestamp=datetime.now(),
                   hello="world")

Then, using the ``FastApp`` CLI we can serve this App:

.. code-block:: shell

   fastapp serve-debug main:app

...or via docker:

.. code-block:: shell

   docker run --rm -it \
       --publish 8080:8080 \
       --volume ${PWD}/main.py:/root/fastapp/main.py \
       juftin/fastapp:latest \
       serve-debug main:app

Test out our new endpoint:

.. code-block:: shell

   curl \
     --request GET \
     --header "Content-Type: application/json" \
     http://localhost:8080/hello

Alternatively, if we want to serve this app using Gunicorn, Nginx, and the UvicornWorker we can use
the ``serve`` command:

.. code-block:: shell

   fastapp serve main:app

I prefer doing this within a docker container so you don't have to run Nginx on the host machine:

.. code-block:: shell

   docker run --rm -it \
       --publish 8080:8080 \
       --volume ${PWD}/main.py:/root/fastapp/main.py \
       juftin/fastapp:latest \
       serve main:app