docs updated, mypy types fixed

Author: igorbenav

README.md

@@ -269,7 +269,7 @@ So you may skip to [5. Extending](#5-extending).
 ### 4.2 From Scratch
 
 #### 4.2.1. Packages
-In the `src` directory, run to install required packages:
+In the `root` directory (`FastAPI-boilerplate` if you didn't change anything), run to install required packages:
 ```sh
 poetry install
 ```
@@ -330,9 +330,9 @@ redis:alpine
 ```
 
 #### 4.2.4. Running the API
-While in the `src` folder, run to start the application with uvicorn server:
+While in the `root` folder, run to start the application with uvicorn server:
 ```sh
-poetry run uvicorn app.main:app --reload
+poetry run uvicorn src.app.main:app --reload
 ```
 > [!TIP]
 > The --reload flag enables auto-reload once you change (and save) something in the project
@@ -345,7 +345,7 @@ poetry run uvicorn app.main:app --reload
 
 If you are using docker compose, you should uncomment this part of the docker-compose.yml:
 ```
-  # #-------- uncomment to create first superuser --------
+  #-------- uncomment to create first superuser --------
   # create_superuser:
   #   build: 
   #     context: .
@@ -391,9 +391,9 @@ docker-compose stop create_superuser
 ```
 
 #### 4.3.2 From Scratch
-While in the `src` folder, run (after you started the application at least once to create the tables):
+While in the `root` folder, run (after you started the application at least once to create the tables):
 ```sh
-poetry run python -m scripts.create_first_superuser
+poetry run python -m src.scripts.create_first_superuser
 ```
 
 ### 4.3.3 Creating the first tier
@@ -1139,9 +1139,9 @@ async def get_task(task_id: str):
 And finally run the worker in parallel to your fastapi application.
 
 If you are using `docker compose`, the worker is already running.
-If you are doing it from scratch, run while in the `src` folder:
+If you are doing it from scratch, run while in the `root` folder:
 ```sh
-poetry run arq app.worker.WorkerSettings
+poetry run arq src.app.worker.WorkerSettings
 ```
 ### 5.11 Rate Limiting
 To limit how many times a user can make a request in a certain interval of time (very useful to create subscription plans or just to protect your API against DDOS), you may just use the `rate_limiter` dependency:
@@ -1301,14 +1301,14 @@ docker compose up
 ```
 
 If you are doing it from scratch, ensure your postgres and your redis are running, then
-while in the `src` folder, run to start the application with uvicorn server:
+while in the `root` folder, run to start the application with uvicorn server:
 ```sh
-poetry run uvicorn app.main:app --reload
+poetry run uvicorn src.app.main:app --reload
 ```
 
 And for the worker:
 ```sh
-poetry run arq app.worker.WorkerSettings
+poetry run arq src.app.worker.WorkerSettings
 ```
 
 ## 6. Running in Production
@@ -1366,7 +1366,7 @@ To run with NGINX, you start by uncommenting the following part in your `docker-
 # docker-compose.yml
 
 ...
-  # #-------- uncomment to run with nginx --------
+  #-------- uncomment to run with nginx --------
   # nginx:
   #   image: nginx:latest
   #   ports:
@@ -1501,20 +1501,20 @@ Now, to run:
 ### 7.1  Docker Compose
 First you need to uncomment the following part in the `docker-compose.yml` file:
 ```
-  # #-------- uncomment to run tests --------
+  #-------- uncomment to run tests --------
   # pytest:
   #   build: 
   #     context: .
   #     dockerfile: Dockerfile 
   #   env_file:
-  #     - ./src/.env 
+  #     - ./src/.env
   #   depends_on:
   #     - db
   #     - create_superuser
   #     - redis
-  #   command: python -m pytest
+  #   command: python -m pytest ./tests
   #   volumes:
-  #     - ./src:/code/src
+  #     - .:/code
 ```
 
 You'll get:
@@ -1525,14 +1525,14 @@ You'll get:
       context: .
       dockerfile: Dockerfile 
     env_file:
-      - ./src/.env 
+      - ./src/.env
     depends_on:
       - db
       - create_superuser
       - redis
-    command: python -m pytest
+    command: python -m pytest ./tests
     volumes:
-      - ./src:/code/src
+      - .:/code
 ```
 
 Start the Docker Compose services:
@@ -1548,7 +1548,7 @@ docker-compose run --rm pytest
 
 ### 7.2  From Scratch
 
-While in the `src` folder, run:
+While in the `root` folder, run:
 ```sh
 poetry run python -m pytest
 ```
@@ -1557,7 +1557,7 @@ poetry run python -m pytest
 Contributions are appreciated, even if just reporting bugs, documenting stuff or answering questions. To contribute with a feature:
 1. Fork it (https://github.com/igormagalhaesr/FastAPI-boilerplate)
 2. Create your feature branch (`git checkout -b feature/fooBar`)
-3. Test your changes while in the src folder `poetry run python -m pytest`
+3. Test your changes while in the root folder `poetry run python -m pytest`
 4. Commit your changes (`git commit -am 'Add some fooBar'`)
 5. Push to the branch (`git push origin feature/fooBar`)
 6. Create a new Pull Request

src/app/api/dependencies.py

@@ -36,7 +36,7 @@ async def get_current_user(
         raise UnauthorizedException("User not authenticated.")
 
     if "@" in token_data.username_or_email:
-        user: dict = await crud_users.get(db=db, email=token_data.username_or_email, is_deleted=False)
+        user: dict | None = await crud_users.get(db=db, email=token_data.username_or_email, is_deleted=False)
     else: 
         user = await crud_users.get(db=db, username=token_data.username_or_email, is_deleted=False)
 

src/app/api/v1/posts.py

@@ -50,7 +50,7 @@ async def read_posts(
     db: Annotated[AsyncSession, Depends(async_get_db)],
     page: int = 1,
     items_per_page: int = 10
-) -> PaginatedListResponse[PostRead]:
+) -> dict:
     db_user = await crud_users.get(db=db, schema_to_select=UserRead, username=username, is_deleted=False)
     if not db_user:
         raise NotFoundException("User not found")
@@ -65,7 +65,7 @@ async def read_posts(
     )
 
     return paginated_response(
-        crud_data=posts_data, 
+        crud_data=posts_data["data"], 
         page=page, 
         items_per_page=items_per_page
     )
@@ -78,7 +78,7 @@ async def read_post(
     username: str,
     id: int, 
     db: Annotated[AsyncSession, Depends(async_get_db)]
-) -> PostRead:
+) -> dict:
     db_user = await crud_users.get(db=db, schema_to_select=UserRead, username=username, is_deleted=False)
     if db_user is None:
         raise NotFoundException("User not found")

src/app/api/v1/rate_limits.py

@@ -48,7 +48,7 @@ async def read_rate_limits(
     db: Annotated[AsyncSession, Depends(async_get_db)],
     page: int = 1,
     items_per_page: int = 10
-) -> PaginatedListResponse[RateLimitRead]:
+) -> dict:
     db_tier = await crud_tiers.get(db=db, name=tier_name)
     if not db_tier:
         raise NotFoundException("Tier not found")
@@ -62,7 +62,7 @@ async def read_rate_limits(
     )
 
     return paginated_response(
-        crud_data=rate_limits_data, 
+        crud_data=rate_limits_data["data"], 
         page=page, 
         items_per_page=items_per_page
     )
@@ -74,7 +74,7 @@ async def read_rate_limit(
     tier_name: str,
     id: int,
     db: Annotated[AsyncSession, Depends(async_get_db)]
-) -> RateLimitRead:
+) -> dict:
     db_tier = await crud_tiers.get(db=db, name=tier_name)
     if not db_tier:
         raise NotFoundException("Tier not found")

src/app/api/v1/tasks.py

@@ -24,7 +24,7 @@ async def create_task(message: str) -> Dict[str, str]:
     Dict[str, str]
         A dictionary containing the ID of the created task.
     """
-    job = await queue.pool.enqueue_job("sample_background_task", message)
+    job = await queue.pool.enqueue_job("sample_background_task", message) # type: ignore
     return {"id": job.job_id}
 
 

src/app/api/v1/tiers.py

@@ -39,7 +39,7 @@ async def read_tiers(
     db: Annotated[AsyncSession, Depends(async_get_db)],
     page: int = 1,
     items_per_page: int = 10
-) -> PaginatedListResponse[TierRead]:
+) -> dict:
     tiers_data = await crud_tiers.get_multi(
         db=db,
         offset=compute_offset(page, items_per_page),
@@ -48,7 +48,7 @@ async def read_tiers(
     )
 
     return paginated_response(
-        crud_data=tiers_data, 
+        crud_data=tiers_data["data"], 
         page=page, 
         items_per_page=items_per_page
     )
@@ -59,7 +59,7 @@ async def read_tier(
     request: Request,
     name: str, 
     db: Annotated[AsyncSession, Depends(async_get_db)]
-) -> TierRead:
+) -> dict:
     db_tier = await crud_tiers.get(db=db, schema_to_select=TierRead, name=name)
     if db_tier is None:
         raise NotFoundException("Tier not found")

src/app/api/v1/users.py

@@ -47,17 +47,17 @@ async def read_users(
     db: Annotated[AsyncSession, Depends(async_get_db)],
     page: int = 1,
     items_per_page: int = 10
-) -> PaginatedListResponse[UserRead]:
+) -> dict:
     users_data = await crud_users.get_multi(
         db=db,
         offset=compute_offset(page, items_per_page),
         limit=items_per_page,
-        schema_to_select=UserRead, 
+        schema_to_select=UserRead,
         is_deleted=False
     )
-    
+
     return paginated_response(
-        crud_data=users_data, 
+        crud_data=users_data["data"],
         page=page, 
         items_per_page=items_per_page
     )
@@ -76,7 +76,7 @@ async def read_user(
     request: Request, 
     username: str, 
     db: Annotated[AsyncSession, Depends(async_get_db)]
-) -> UserRead:
+) -> dict:
     db_user = await crud_users.get(db=db, schema_to_select=UserRead, username=username, is_deleted=False)
     if db_user is None:
         raise NotFoundException("User not found")
@@ -144,7 +144,7 @@ async def erase_db_user(
     if not db_user:
         raise NotFoundException("User not found")
 
-    db_user = await crud_users.db_delete(db=db, username=username)
+    await crud_users.db_delete(db=db, username=username)
     await blacklist_token(token=token, db=db)
     return {"message": "User deleted from the database"}
 
@@ -155,7 +155,7 @@ async def read_user_rate_limits(
     username: str,
     db: Annotated[AsyncSession, Depends(async_get_db)]
 ) -> Dict[str, Any]:
-    db_user: dict = await crud_users.get(db=db, username=username, schema_to_select=UserRead)
+    db_user: dict | None = await crud_users.get(db=db, username=username, schema_to_select=UserRead)
     if db_user is None:
         raise NotFoundException("User not found")
 
@@ -182,7 +182,7 @@ async def read_user_tier(
     request: Request,
     username: str,
     db: Annotated[AsyncSession, Depends(async_get_db)]
-) -> Union[UserRead, TierRead]:
+) -> dict | None:
     db_user = await crud_users.get(db=db, username=username, schema_to_select=UserRead)
     if db_user is None:
         raise NotFoundException("User not found")
@@ -195,7 +195,7 @@ async def read_user_tier(
         db=db, 
         join_model=Tier, 
         join_prefix="tier_", 
-        schema_to_select=UserRead, 
+        schema_to_select=UserRead,
         join_schema_to_select=TierRead,
         username=username
     )

src/app/core/security.py

@@ -29,7 +29,7 @@ def get_password_hash(password: str) -> str:
 
 async def authenticate_user(username_or_email: str, password: str, db: AsyncSession) -> Union[Dict[str, Any], Literal[False]]:
     if "@" in username_or_email:
-        db_user: dict = await crud_users.get(db=db, email=username_or_email, is_deleted=False)
+        db_user: dict | None = await crud_users.get(db=db, email=username_or_email, is_deleted=False)
     else:
         db_user = await crud_users.get(db=db, username=username_or_email, is_deleted=False)
 

src/app/core/setup.py

@@ -40,7 +40,7 @@ async def create_redis_cache_pool() -> None:
 
 
 async def close_redis_cache_pool() -> None:
-    await cache.client.aclose()
+    await cache.client.aclose() # type: ignore
 
 
 # -------------- queue --------------
@@ -51,7 +51,7 @@ async def create_redis_queue_pool() -> None:
 
 
 async def close_redis_queue_pool() -> None:
-    await queue.pool.aclose()
+    await queue.pool.aclose() # type: ignore
 
 
 # -------------- rate limit --------------
@@ -61,7 +61,7 @@ async def create_redis_rate_limit_pool() -> None:
 
 
 async def close_redis_rate_limit_pool() -> None:
-    await rate_limit.client.aclose()
+    await rate_limit.client.aclose() # type: ignore
 
 
 # -------------- application --------------