add initial source

README.md

@@ -7,10 +7,19 @@ https://fastapi.tiangolo.com/
 python -m pip install --upgrade pip
 ```
 
+```bash
+python -m pip install -r requirements-dev.txt
+```
+
 ```bash
 python -m pip install -r requirements.txt
 ```
 
+## test / lint
+```bash
+pylint main.py
+```
+
 ## run server
 ```bash
 uvicorn main:app --reload

main.py

@@ -1,3 +1,6 @@
+"""
+This is the main file for the FastAPI tutorial
+"""
 from typing import Union
 
 from fastapi import FastAPI
@@ -7,9 +10,19 @@
 
 @app.get("/")
 def read_root():
+    """
+    This is the root path
+    :return:
+    """
     return {"Hello": "World"}
 
 
 @app.get("/items/{item_id}")
 def read_item(item_id: int, q: Union[str, None] = None):
+    """
+    This is the item path
+    :param item_id:
+    :param q:
+    :return:
+    """
     return {"item_id": item_id, "q": q}

qodana.yaml

@@ -1,2 +1,10 @@
 version: "1.0"
 linter: jetbrains/qodana-python-community:2023.3
+#linter: jetbrains/qodana-python:2022.3-eap
+bootstrap: |
+  rm -rf .idea
+  pip install -r requirements.txt --quiet
+profile:
+  name: qodana.recommended
+include:
+  - name: CheckDependencyLicenses

requirements-dev.txt

@@ -0,0 +1,2 @@
+-r requirements.txt
+pylint==3.0.3