Merge pull request #65 from igorbenav/folder-structure

Folder structure

Author: igorbenav

Dockerfile

@@ -6,7 +6,7 @@ WORKDIR /tmp
 
 RUN pip install poetry
 
-COPY src/pyproject.toml src/poetry.lock* /tmp/
+COPY ./pyproject.toml ./poetry.lock* /tmp/
 
 RUN poetry export -f requirements.txt --output requirements.txt --without-hashes
 

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
@@ -423,15 +423,21 @@ First, you may want to take a look at the project structure and understand what
 ```sh
 .
 ├── Dockerfile                        # Dockerfile for building the application container.
-├── LICENSE.md                        # License file for the project.
-├── README.md                         # Project README providing information and instructions.
 ├── docker-compose.yml                # Docker Compose file for defining multi-container applications.
+├── pyproject.toml                    # Poetry configuration file with project metadata and dependencies.
+├── README.md                         # Project README providing information and instructions.
+├── LICENSE.md                        # License file for the project.
+│
+├── tests                             # Unit and integration tests for the application.
+│   ├── __init__.py
+│   ├── conftest.py                   # Configuration and fixtures for pytest.
+│   ├── helper.py                     # Helper functions for tests.
+│   └── test_user.py                  # Test cases for user-related functionality.
 │
 └── src                               # Source code directory.
     ├── __init__.py                   # Initialization file for the src package.
     ├── alembic.ini                   # Configuration file for Alembic (database migration tool).
     ├── poetry.lock                   # Poetry lock file specifying exact versions of dependencies.
-    ├── pyproject.toml                # Poetry configuration file with project metadata and dependencies.
     │
     ├── app                           # Main application directory.
     │   ├── __init__.py               # Initialization file for the app package.
@@ -517,16 +523,10 @@ First, you may want to take a look at the project structure and understand what
     │   └── versions                  # Individual migration scripts.
     │       └── README.MD
     │
-    ├── scripts                       # Utility scripts for the application.
-    │   ├── __init__.py
-    │   ├── create_first_superuser.py # Script to create the first superuser.
-    │   └── create_first_tier.py      # Script to create the first user tier.
-    │
-    └── tests                         # Unit and integration tests for the application.
+    └── scripts                       # Utility scripts for the application.
         ├── __init__.py
-        ├── conftest.py               # Configuration and fixtures for pytest.
-        ├── helper.py                 # Helper functions for tests.
-        └── test_user.py              # Test cases for user-related functionality.
+        ├── create_first_superuser.py # Script to create the first superuser.
+        └── create_first_tier.py      # Script to create the first user tier.
 ```
 
 ### 5.2 Database Model
@@ -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

docker-compose.yml

@@ -50,7 +50,7 @@ services:
     expose:
       - "6379"
 
-  # #-------- uncomment to run with nginx --------
+  #-------- uncomment to run with nginx --------
   # nginx:
   #   image: nginx:latest
   #   ports:
@@ -60,7 +60,7 @@ services:
   #   depends_on:
   #     - web
 
-  # #-------- uncomment to create first superuser --------
+  #-------- uncomment to create first superuser --------
   # create_superuser:
   #   build: 
   #     context: .
@@ -80,16 +80,16 @@ services:
   #     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
 
-  # #-------- uncomment to create first tier --------
+  #-------- uncomment to create first tier --------
   # create_tier:
   #   build: 
   #     context: .

src/pyproject.toml renamed to pyproject.toml

@@ -1,6 +1,6 @@
 from fastapi import APIRouter
 
-from app.api.v1 import router as v1_router
+from ..api.v1 import router as v1_router
 
 router = APIRouter(prefix="/api")
 router.include_router(v1_router)

src/app/api/__init__.py

@@ -1,8 +1,5 @@
 from typing import Annotated, Union, Any
 
-from app.core.security import SECRET_KEY, ALGORITHM, oauth2_scheme
-from app.core.config import settings
-
 from sqlalchemy.ext.asyncio import AsyncSession
 from jose import JWTError, jwt
 from fastapi import (
@@ -11,17 +8,19 @@
     Request
 )
 
-from app.core.exceptions.http_exceptions import UnauthorizedException, ForbiddenException, RateLimitException
-from app.core.db.database import async_get_db
-from app.core.logger import logging
-from app.core.schemas import TokenData
-from app.core.utils.rate_limit import is_rate_limited
-from app.core.security import verify_token
-from app.crud.crud_rate_limit import crud_rate_limits
-from app.crud.crud_tier import crud_tiers
-from app.crud.crud_users import crud_users
-from app.models.user import User
-from app.schemas.rate_limit import sanitize_path
+from ..core.security import oauth2_scheme
+from ..core.config import settings
+from ..core.exceptions.http_exceptions import UnauthorizedException, ForbiddenException, RateLimitException
+from ..core.db.database import async_get_db
+from ..core.logger import logging
+from ..core.schemas import TokenData
+from ..core.utils.rate_limit import is_rate_limited
+from ..core.security import verify_token
+from ..crud.crud_rate_limit import crud_rate_limits
+from ..crud.crud_tier import crud_tiers
+from ..crud.crud_users import crud_users
+from ..models.user import User
+from ..schemas.rate_limit import sanitize_path
 
 logger = logging.getLogger(__name__)
 
@@ -37,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/dependencies.py

@@ -1,12 +1,12 @@
 from fastapi import APIRouter
 
-from app.api.v1.login import router as login_router
-from app.api.v1.logout import router as logout_router
-from app.api.v1.users import router as users_router
-from app.api.v1.posts import router as posts_router
-from app.api.v1.tasks import router as tasks_router
-from app.api.v1.tiers import router as tiers_router
-from app.api.v1.rate_limits import router as rate_limits_router
+from .login import router as login_router
+from .logout import router as logout_router
+from .users import router as users_router
+from .posts import router as posts_router
+from .tasks import router as tasks_router
+from .tiers import router as tiers_router
+from .rate_limits import router as rate_limits_router
 
 router = APIRouter(prefix="/v1")
 router.include_router(login_router)

src/app/api/v1/__init__.py

@@ -1,16 +1,16 @@
 from typing import Annotated, Dict
-from datetime import timedelta, datetime, timezone
+from datetime import timedelta
 
 from fastapi import Response, Request, Depends
 from fastapi.security import OAuth2PasswordRequestForm
 from sqlalchemy.ext.asyncio import AsyncSession
 import fastapi
 
-from app.core.config import settings
-from app.core.db.database import async_get_db
-from app.core.exceptions.http_exceptions import UnauthorizedException
-from app.core.schemas import Token
-from app.core.security import (
+from ...core.config import settings
+from ...core.db.database import async_get_db
+from ...core.exceptions.http_exceptions import UnauthorizedException
+from ...core.schemas import Token
+from ...core.security import (
     ACCESS_TOKEN_EXPIRE_MINUTES, 
     create_access_token, 
     authenticate_user, 

src/app/api/v1/login.py

@@ -4,9 +4,9 @@
 from sqlalchemy.ext.asyncio import AsyncSession
 from jose import JWTError
 
-from app.core.security import oauth2_scheme, blacklist_token
-from app.core.db.database import async_get_db
-from app.core.exceptions.http_exceptions import UnauthorizedException
+from ...core.security import oauth2_scheme, blacklist_token
+from ...core.db.database import async_get_db
+from ...core.exceptions.http_exceptions import UnauthorizedException
 
 router = APIRouter(tags=["login"])