├── .github └── workflows │ └── main.yml ├── .gitignore ├── LICENSE ├── README.md ├── main.py ├── models.py ├── requirements.txt ├── routes.py └── test_books_crud.py /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | # Controls when the workflow will run 4 | on: 5 | # Triggers the workflow on push or pull request events but only for the main branch 6 | push: 7 | branches: [ main ] 8 | pull_request: 9 | branches: [ main ] 10 | 11 | # Allows you to run this workflow manually from the Actions tab 12 | workflow_dispatch: 13 | 14 | # A workflow run is made up of one or more jobs that can run sequentially or in parallel 15 | jobs: 16 | # This workflow contains a single job called "test" 17 | 18 | test: 19 | # The type of runner that the job will run on 20 | runs-on: ubuntu-latest 21 | environment: Testing 22 | 23 | # Steps represent a sequence of tasks that will be executed as part of the job 24 | steps: 25 | # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it 26 | - uses: actions/checkout@v2 27 | 28 | - name: Install dependencies 29 | run: python -m pip install -r ./requirements.txt 30 | 31 | - name: Set Atlas Cluster URI 32 | env: 33 | ATLAS_URI: ${{ secrets.ATLAS_URI }} 34 | run: echo "ATLAS_URI=$ATLAS_URI" > .env && echo "DB_NAME=pymongo_tutorial" >> .env 35 | 36 | - name: Run tests 37 | run: python -m pip install pytest && python -m pytest 38 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .env 2 | __pycache__/ 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | Copyright 2022 MongoDB Inc. 179 | 180 | Licensed under the Apache License, Version 2.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | http://www.apache.org/licenses/LICENSE-2.0 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![main workflow](https://github.com/mongodb-developer/pymongo-fastapi-crud/actions/workflows/main.yml/badge.svg) 2 | 3 | # PyMongo with FastAPI CRUD application 4 | 5 | This is a simple CRUD application built using PyMongo and FastAPI. You can also follow the step-by-step [tutorial](https://www.mongodb.com/languages/python/pymongo-tutorial) for building this application. 6 | 7 | ## Running the server 8 | 9 | Set your [Atlas URI connection string](https://docs.atlas.mongodb.com/getting-started/) as a parameter in `.env`. Make sure you replace the username and password placeholders with your own credentials. 10 | 11 | ``` 12 | ATLAS_URI=mongodb+srv://:@sandbox.jadwj.mongodb.net 13 | DB_NAME=pymongo_tutorial 14 | ``` 15 | 16 | Install the required dependencies: 17 | 18 | ``` 19 | python -m pip install -r requirements.txt 20 | ``` 21 | 22 | Start the server: 23 | ``` 24 | python -m uvicorn main:app --reload 25 | ``` 26 | 27 | When the application starts, navigate to `http://localhost:8000/docs` and try out the `book` endpoints. 28 | 29 | ## Running the tests 30 | 31 | Install `pytest`: 32 | 33 | ``` 34 | python -m pip install pytest 35 | ``` 36 | 37 | Execute the tests: 38 | 39 | ``` 40 | python -m pytest 41 | ``` 42 | 43 | ## Disclaimer 44 | 45 | Use at your own risk; not a supported MongoDB product 46 | -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | from fastapi import FastAPI 2 | from dotenv import dotenv_values 3 | from pymongo import MongoClient 4 | from routes import router as book_router 5 | 6 | config = dotenv_values(".env") 7 | 8 | app = FastAPI() 9 | 10 | @app.on_event("startup") 11 | def startup_db_client(): 12 | app.mongodb_client = MongoClient(config["ATLAS_URI"]) 13 | app.database = app.mongodb_client[config["DB_NAME"]] 14 | 15 | @app.on_event("shutdown") 16 | def shutdown_db_client(): 17 | app.mongodb_client.close() 18 | 19 | app.include_router(book_router, tags=["books"], prefix="/book") 20 | 21 | -------------------------------------------------------------------------------- /models.py: -------------------------------------------------------------------------------- 1 | import uuid 2 | from typing import Optional 3 | from pydantic import BaseModel, Field 4 | 5 | class Book(BaseModel): 6 | id: str = Field(default_factory=uuid.uuid4, alias="_id") 7 | title: str = Field(...) 8 | author: str = Field(...) 9 | synopsis: str = Field(...) 10 | 11 | class Config: 12 | allow_population_by_field_name = True 13 | schema_extra = { 14 | "example": { 15 | "_id": "066de609-b04a-4b30-b46c-32537c7f1f6e", 16 | "title": "Don Quixote", 17 | "author": "Miguel de Cervantes", 18 | "synopsis": "..." 19 | } 20 | } 21 | 22 | 23 | class BookUpdate(BaseModel): 24 | title: Optional[str] 25 | author: Optional[str] 26 | synopsis: Optional[str] 27 | 28 | class Config: 29 | schema_extra = { 30 | "example": { 31 | "title": "Don Quixote", 32 | "author": "Miguel de Cervantes", 33 | "synopsis": "Don Quixote is a Spanish novel by Miguel de Cervantes..." 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | fastapi[all]==0.75.0 2 | pydantic==1.9 3 | pymongo[srv]==3.11.0 4 | python-dotenv==0.19.2 5 | pytest==7.0.1 6 | -------------------------------------------------------------------------------- /routes.py: -------------------------------------------------------------------------------- 1 | from fastapi import APIRouter, Body, Request, Response, HTTPException, status 2 | from fastapi.encoders import jsonable_encoder 3 | from typing import List 4 | 5 | from models import Book, BookUpdate 6 | 7 | router = APIRouter() 8 | 9 | @router.post("/", response_description="Create a new book", status_code=status.HTTP_201_CREATED, response_model=Book) 10 | def create_book(request: Request, book: Book = Body(...)): 11 | book = jsonable_encoder(book) 12 | new_book = request.app.database["books"].insert_one(book) 13 | created_book = request.app.database["books"].find_one( 14 | {"_id": new_book.inserted_id} 15 | ) 16 | 17 | return created_book 18 | 19 | 20 | @router.get("/", response_description="List all books", response_model=List[Book]) 21 | def list_books(request: Request): 22 | books = list(request.app.database["books"].find(limit=100)) 23 | return books 24 | 25 | 26 | @router.get("/{id}", response_description="Get a single book by id", response_model=Book) 27 | def find_book(id: str, request: Request): 28 | if (book := request.app.database["books"].find_one({"_id": id})) is not None: 29 | return book 30 | 31 | raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=f"Book with ID {id} not found") 32 | 33 | 34 | @router.put("/{id}", response_description="Update a book", response_model=Book) 35 | def update_book(id: str, request: Request, book: BookUpdate = Body(...)): 36 | book = {k: v for k, v in book.dict().items() if v is not None} 37 | 38 | if len(book) >= 1: 39 | update_result = request.app.database["books"].update_one( 40 | {"_id": id}, {"$set": book} 41 | ) 42 | 43 | if update_result.modified_count == 0: 44 | raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=f"Book with ID {id} not found") 45 | 46 | if ( 47 | existing_book := request.app.database["books"].find_one({"_id": id}) 48 | ) is not None: 49 | return existing_book 50 | 51 | raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=f"Book with ID {id} not found") 52 | 53 | 54 | @router.delete("/{id}", response_description="Delete a book") 55 | def delete_book(id: str, request: Request, response: Response): 56 | delete_result = request.app.database["books"].delete_one({"_id": id}) 57 | 58 | if delete_result.deleted_count == 1: 59 | response.status_code = status.HTTP_204_NO_CONTENT 60 | return response 61 | 62 | raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=f"Book with ID {id} not found") 63 | -------------------------------------------------------------------------------- /test_books_crud.py: -------------------------------------------------------------------------------- 1 | from fastapi import FastAPI 2 | from fastapi.testclient import TestClient 3 | from dotenv import dotenv_values 4 | from pymongo import MongoClient 5 | from routes import router as book_router 6 | 7 | app = FastAPI() 8 | config = dotenv_values(".env") 9 | app.include_router(book_router, tags=["books"], prefix="/book") 10 | 11 | 12 | @app.on_event("startup") 13 | async def startup_event(): 14 | app.mongodb_client = MongoClient(config["ATLAS_URI"]) 15 | app.database = app.mongodb_client[config["DB_NAME"] + "test"] 16 | 17 | @app.on_event("shutdown") 18 | async def shutdown_event(): 19 | app.mongodb_client.close() 20 | app.database.drop_collection("books") 21 | 22 | def test_create_book(): 23 | with TestClient(app) as client: 24 | response = client.post("/book/", json={"title": "Don Quixote", "author": "Miguel de Cervantes", "synopsis": "..."}) 25 | assert response.status_code == 201 26 | 27 | body = response.json() 28 | assert body.get("title") == "Don Quixote" 29 | assert body.get("author") == "Miguel de Cervantes" 30 | assert body.get("synopsis") == "..." 31 | assert "_id" in body 32 | 33 | 34 | def test_create_book_missing_title(): 35 | with TestClient(app) as client: 36 | response = client.post("/book/", json={"author": "Miguel de Cervantes", "synopsis": "..."}) 37 | assert response.status_code == 422 38 | 39 | 40 | def test_create_book_missing_author(): 41 | with TestClient(app) as client: 42 | response = client.post("/book/", json={"title": "Don Quixote", "synopsis": "..."}) 43 | assert response.status_code == 422 44 | 45 | 46 | def test_create_book_missing_synopsis(): 47 | with TestClient(app) as client: 48 | response = client.post("/book/", json={"title": "Don Quixote", "author": "Miguel de Cervantes"}) 49 | assert response.status_code == 422 50 | 51 | 52 | def test_get_book(): 53 | with TestClient(app) as client: 54 | new_book = client.post("/book/", json={"title": "Don Quixote", "author": "Miguel de Cervantes", "synopsis": "..."}).json() 55 | 56 | get_book_response = client.get("/book/" + new_book.get("_id")) 57 | assert get_book_response.status_code == 200 58 | assert get_book_response.json() == new_book 59 | 60 | 61 | def test_get_book_unexisting(): 62 | with TestClient(app) as client: 63 | get_book_response = client.get("/book/unexisting_id") 64 | assert get_book_response.status_code == 404 65 | 66 | 67 | def test_update_book(): 68 | with TestClient(app) as client: 69 | new_book = client.post("/book/", json={"title": "Don Quixote", "author": "Miguel de Cervantes", "synopsis": "..."}).json() 70 | 71 | response = client.put("/book/" + new_book.get("_id"), json={"title": "Don Quixote 1"}) 72 | assert response.status_code == 200 73 | assert response.json().get("title") == "Don Quixote 1" 74 | 75 | 76 | def test_update_book_unexisting(): 77 | with TestClient(app) as client: 78 | update_book_response = client.put("/book/unexisting_id", json={"title": "Don Quixote 1"}) 79 | assert update_book_response.status_code == 404 80 | 81 | 82 | def test_delete_book(): 83 | with TestClient(app) as client: 84 | new_book = client.post("/book/", json={"title": "Don Quixote", "author": "Miguel de Cervantes", "synopsis": "..."}).json() 85 | 86 | delete_book_response = client.delete("/book/" + new_book.get("_id")) 87 | assert delete_book_response.status_code == 204 88 | 89 | 90 | def test_delete_book_unexisting(): 91 | with TestClient(app) as client: 92 | delete_book_response = client.delete("/book/unexisting_id") 93 | assert delete_book_response.status_code == 404 94 | 95 | --------------------------------------------------------------------------------