Readme is updated with dev's information about maintenance. mypy is run.

Author: e-io

README.md

@@ -36,6 +36,37 @@ Open any link in any browser
  * ReDoc http://127.0.0.1:8080/redoc
  * OpenAPI documentation (json) http://127.0.0.1:8080/openapi.json
 
+## A tidy up and a health check
+
+Install additional "developer's" requirements
+```bash
+pip install -r requirements-dev.txt
+```
+
+A linter
+```bash
+ruff src
+```
+
+A linter's fixing tool
+```bash
+ruff src --fix
+```
+
+A formatter
+```bash
+ruff format src
+```
+
+A default 'health-checking' linter
+```bash
+flake8 src
+```
+
+A static type checker tool
+```bash
+mypy src
+```
 
 # Проектное задание четвёртого спринта
 

src/core/config.py

@@ -1,3 +1,9 @@
+"""
+Run through console:
+
+uvicorn src.main:app --host 127.0.0.1 --port 8080
+additional notes are in the `../README.md` file
+"""
 from pathlib import Path
 
 from pydantic import BaseSettings
@@ -7,7 +13,8 @@
 
 
 class AppSettings(BaseSettings):
-    PROJECT_NAME: str  # set any name in '.env' file
+    # Don't use this name, set any name in '.env' file.
+    PROJECT_NAME: str = "Default app's name"
 
     class Config:
         env_file = '.env'