setup and create

Author: rachel-mack

snooty.toml

@@ -11,7 +11,8 @@ toc_landing_pages = [
     "crud",
     "/crud/query",
     "/crud/update",
-    "/monitoring-and-logging"
+    "/monitoring-and-logging",
+    "integrations"
 ]
 
 intersphinx = [

source/integrations/fastapi-integration.txt

@@ -18,75 +18,85 @@ FastAPI Integration Tutorial
    :description: Learn how to create an app to connect to MongoDB deployment by using the PyMongo driver.
    :keywords: quick start, tutorial, basics
 
-`FastAPI <https://fastapi.tiangolo.com/>`__ is a modern, high-performance, easy-to-learn, fast-to-code, production-ready, Python 3.6+ framework for building APIs based on standard Python type hints. While it might not be as established as some other Python frameworks such as Django, it is already in production at companies such as Uber, Netflix, and Microsoft.
-
-FastAPI is async, and as its name implies, it is super fast; so, MongoDB is the perfect accompaniment. In this quick start, we will create a CRUD (Create, Read, Update, Delete) app showing how you can integrate MongoDB with your FastAPI projects.
+`FastAPI <https://fastapi.tiangolo.com/>`__ is a high-performance,
+production-ready asynchronous Python framework for building APIs based on
+standard Python type hints. In this tutorial, we will create a CRUD application
+showing how you can integrate MongoDB with your FastAPI projects.
 
 Prerequisites
 -------------
 
--   Python 3.9.0
--   A MongoDB Atlas cluster. Follow the "`Get Started with Atlas <https://docs.atlas.mongodb.com/getting-started/>`__" guide to create your account and MongoDB cluster. Keep a note of your username, password, and `connection string <https://docs.atlas.mongodb.com/tutorial/connect-to-your-cluster/#connect-to-your-atlas-cluster>`__` as you will need those later.
+-   Python v3.9.0 or later
+-   A MongoDB Atlas cluster 
+    See the `Get Started with Atlas
+    <https://docs.atlas.mongodb.com/getting-started/>`__ guide to create your
+    account and MongoDB cluster. 
 
-Running the Example
--------------------
+Set-up
+------
 
-To begin, you should `clone the example code from GitHub <https://github.com/mongodb-developer/mongodb-with-fastapi>`__.
+1. Clone the example code from the `mongodb-with-fastapi repository <https://github.com/mongodb-developer/mongodb-with-fastapi>`__:
 
-.. code-block:: shell
+   .. code-block:: shell
 
-   git clone [email protected]:mongodb-developer/mongodb-with-fastapi.git
+      git clone [email protected]:mongodb-developer/mongodb-with-fastapi.git 
 
-You will need to install a few dependencies: FastAPI, `Motor <https://motor.readthedocs.io/>`__, etc. I always recommend that you install all Python dependencies in a `virtualenv <https://docs.python.org/3/tutorial/venv.html>`__ for the project. Before running pip, ensure your ``virtualenv`` is active.
+#. Install the required dependencies listed in the ``requirements.txt`` file:
 
-.. code-block:: shell
+   .. tip:: Use a Virtual environment
 
-   cd mongodb-with-fastapi
-   pip install -r requirements.txt
+      Installing your Python dependencies in a `virtualenv
+      <https://docs.python.org/3/tutorial/venv.html>`__ with allow for versions
+      of the libraries to be install for individual projects. Before running
+      pip, ensure your ``virtualenv`` is active. 
 
-It may take a few moments to download and install your dependencies.  This is normal, especially if you have not installed a particular package before.
+   .. code-block:: shell
 
-Once you have installed the dependencies, you need to create an environment variable for your MongoDB connection string.
+      cd mongodb-with-fastapi
+      pip install -r requirements.txt
 
-.. code-block:: shell
+   It may take a few moments to download and install your dependencies.
 
-   export MONGODB_URL="mongodb+srv://<username>:<password>@<url>/<db>?retryWrites=true&w=majority"
+#. Create an environment variable for your MongoDB connection string:
 
-Remember, anytime you start a new terminal session, you will need to set this environment variable again. I use `direnv <https://direnv.net/>`__ to make this process easier.
+   .. code-block:: shell
 
-The final step is to start your FastAPI server.
+      export MONGODB_URL="mongodb+srv://<username>:<password>@<url>/<db>?retryWrites=true&w=majority"
 
-.. code-block:: shell
+   .. tip:: Reset Environment Variables
 
-   uvicorn app:app --reload
+      Anytime you start a new terminal session, you will need to reset this
+      environment variable. You can use `direnv <https://direnv.net/>`__ to make
+      this process easier.
 
-.. image:: /includes/integrations/fastapi-terminal.png
-   :alt: Screenshot of terminal running FastAPI
+#. Start your FastAPI server:
 
-Once the application has started, you can view it in your browser at http://127.0.0.1:8000/docs.
+   .. code-block:: shell
 
-.. image:: /includes/integrations/fastapi-browser.png
-   :alt: Screenshot of browser and swagger UI
+      uvicorn app:app --reload
 
-Once you have had a chance to try the example, come back and we will walk through the code.
+   .. image:: /includes/integrations/fastapi-terminal.png
+      :alt: Screenshot of terminal running FastAPI
 
-Creating the Application
-------------------------
+      Once the application has started, you can view it in your browser at http://127.0.0.1:8000/docs.
 
-All the code for the example application is within ``app.py``. I'll break it down into sections and walk through what each is doing.
+   .. image:: /includes/integrations/fastapi-browser.png
+      :alt: Screenshot of browser and swagger UI
 
-Connecting to MongoDB
-~~~~~~~~~~~~~~~~~~~~~
+Create Your Application
+-----------------------
 
-One of the very first things we do is connect to our MongoDB database.
+All the code for the example application is stored in ``app.py``.
 
-.. code-block:: python
+1. Connect to your MongoDB Atlas cluster using the asynchronous `Pymongo Driver
+   <https://www.mongodb.com/docs/languages/python/pymongo-driver/current>`__,
+   then specify the database named ``college``:
 
-   client = motor.motor_asyncio.AsyncIOMotorClient(os.environ[MONGODB_URL])
-   db = client.get_database("college")
-   student_collection = db.get_collection("students")
+   .. code-block:: python
 
-We're using the async `motor driver <https://motor.readthedocs.io/en/stable/>`__ to create our MongoDB client, and then we specify our database name ``college``.
+      client = AsyncMongoClient(MONGODB_URL, server_api=pymongo.server_api.ServerApi(version="1", strict=True, deprecation_errors=True))
+      db = client.get_database("college")
+      student_collection = db.get_collection("students")
 
 The _id Attribute and ObjectIds
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -336,7 +346,12 @@ Our final route is ``delete_student``. Again, because this is acting upon a sing
 Our New FastAPI App Generator
 -----------------------------
 
-If you're excited to build something more production-ready with FastAPI, React & MongoDB, head over to the `Github repository <https://github.com/mongodb-labs/full-stack-fastapi-mongodb>`__ for our `new FastAPI app generator <https://www.mongodb.com/blog/post/introducing-full-stack-fast-api-app-generator-for-python-developers>`__ and start transforming your web development experience.
+If you're excited to build something more production-ready with FastAPI, React &
+MongoDB, head over to the `full-stack-fastapi-mongodb Github repository
+<https://github.com/mongodb-labs/full-stack-fastapi-mongodb>`__ for our `new
+FastAPI app generator
+<https://www.mongodb.com/blog/post/introducing-full-stack-fast-api-app-generator-for-python-developers>`__
+and start transforming your web development experience.
 
 Wrapping Up
 -----------