Adding Makefile. Updating docs.

Author: vincedgy

.gitignore

@@ -4,4 +4,5 @@ __pycache__
 *.pyc
 
 .idea
-.vscode
+.vscode
+*.log

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2020 vincedgy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,69 @@
+# .PHONY defines parts of the makefile that are not dependant on any specific file
+# This is most often used to store functions
+.PHONY = help install test run
+
+# Defines the default target that `make` will to try to make, or in the case of a phony target, execute the specified commands
+# This target is executed whenever we just type `make`
+.DEFAULT_GOAL = help
+
+# Server status evaluation
+SERVER_PID := $(shell sh -c "ps | grep -v grep | grep 'src/main.py' | head -1 | cut -d \t -f1")
+ifeq ('$(strip $(SERVER_PID))','')
+		SERVER_RUNNING=FALSE
+else
+		SERVER_RUNNING=TRUE
+endif
+
+CHILD_PID := $(shell sh -c "ps -ax | grep -i spawn_main | grep -v grep | cut -d ' ' -f1")
+ifeq ('$(strip $(CHILD_PID))','')
+		HAVE_CHILD=FALSE
+else
+		HAVE_CHILD=TRUE
+endif
+
+
+# The @ makes sure that the command itself isn't echoed in the terminal
+help:
+	@echo "---------------HELP-----------------"
+	@echo "- Setup the project : make install"
+	@echo "- Run the server (blocking):  make start"
+	@echo "- Evaluate status of the server :  make status"
+	@echo "- Stop (killp) the server :  make kill"
+	@echo "- Run tests on a running server: make tests"
+	@echo "------------------------------------"
+
+install:
+	@poetry install
+
+status:
+	@date
+	@echo "Running status of server is $(SERVER_RUNNING)"
+	@echo "Running status of child runners is $(HAVE_CHILD)"
+
+do_stop_server:
+	@-kill -9 $(SERVER_PID)
+do_stop_children:
+	@-kill -9 $(CHILD_PID)
+kill: status do_stop_server do_stop_children
+	@echo "Killing server on PID $(SERVER_PID) and children on PID $(CHILD_PID)"
+	@-lsof -i tcp:5000
+
+tail:
+	@tail run.log
+
+do_start:
+	@poetry run python src/main.py >run.log 2>&1 &
+	@$(shell sleep 3)
+start: do_start
+	@echo Check run.log for logging
+
+
+tests: install
+	@poetry run pytest
+
+serve:
+	@poetry run mkdocs serve
+
+publish:
+	@poetry run mkdocs gh-deploy
+

mkdocs.yml

@@ -1,15 +1,17 @@
 site_name: FastAPI with async and Postgresql
-site_url: https://vincedgy.github.io/first_mkdocs/
+site_url: https://vincedgy.github.io/fastapi-async-with-postgresql/
+site_author: vincedgy
+copyright: MIT
 
-repo_url: https://github.com/vincedgy/first_mkdocs
+repo_url: https://github.com/vincedgy/fastapi-async-with-postgresql
 edit_uri: tree/main/docs
 repo_name: GitHub
 
 nav:
     - Home: index.md
     - About: about.md
 theme:
-    name: readthedocs
+    name: mkdocs
     extra_css:
         - css/extra.css
     highlightjs: true

src/main.py

@@ -56,7 +56,7 @@ async def create_note(note: NoteIn):
 @app.put("/notes/{note_id}", response_model=Note)
 async def update_note(note_id: int, payload: NoteIn):
     """Update one note given its id"""
-    query = notes.select().where(text(f"id={note_id}"))
+    query = notes.select().where(notes.c.id == note_id)
     row = await database.fetch_one(query=query)
     if row is None:
         logger.info("No record !")
@@ -97,7 +97,7 @@ async def get_notes(skip: int = 0, take: int = 20):
 @app.get("/notes/{note_id}", response_model=Note, description="Fetch one Note given the note_id")
 async def get_one_note_by_id(note_id: int):
     """Fetch one Note given the note_id"""
-    query = notes.select().where(text(f"id={note_id}"))
+    query = notes.select().where(notes.c.id == note_id)
     row = await database.fetch_one(query=query)
     if row is None:
         logger.info("No record !")

src/tests/test_api.py

@@ -1,5 +1,14 @@
 from src import __version__
 
+import requests
+
 
 def test_version():
+    """Test version"""
     assert __version__ == '0.1.0'
+
+
+def test_get_notes():
+    """Request notes"""
+    response = requests.get("http://localhost:5000/notes")
+    assert response.status_code == 200