yezz123/frdp

Boilerplate code for quick docker implementation of REST API with JWT Authentication using FastAPI, PostgreSQL and PgAdmin ⭐

Hey, Yezz123 here! 👋

---

I'm Yasser Tahiri, Also known as Yezz123, a Software Engineer, Comedian 🤡 by day, OSS 🛠 by night.

• ⚒️ Python / C++ / JavaScript / Rust.
• ✏️ Read to Know The Tech & Tools I use.
• 🌱 I help founders add value by crafting using Python tools.
• 💭 Ask me anything at @Twitter!
• 🔑 GPG key: mQINBGEvjd8BEADja5Cz
• 🫀 Sponsor me

---

frdp's Issues

Fix 3 Maintainability issues in Dockerfile

CodeFactor found multiple issues:

Avoid use of cache directory with pip. Use pip install --no-cache-dir <package>

• Dockerfile:12

Do not use apt as it is meant to be a end-user tool, use apt-get or apt-cache instead

• Dockerfile:3

Using latest is prone to errors if the image will ever update. Pin the version explicitly to a release tag

• Dockerfile:1

Feature : Add Logout Route 🚀

API URL : http://localhost:5000/api/users/logout

Request Headers

• Content-Type: application/json
• authorization: JWT_TOKEN_HERE

Request Body

{
    "token": "JWT_TOKEN_HERE"
}

Response For success

{
    "success": true,
    "msg": "Token revoked"
}

Response for unknown token

{
    "success": false,
    "msg": "User is not logged on"
}

Fix 2 Maintainability issues in crud\base.py

CodeFactor found multiple issues:

Redefining built-in 'id'

• crud\base.py:51
• crud\base.py:18

Fix 3 Maintainability issues in Dockerfile 🛠

CodeFactor found multiple issues last seen at dcfcafe:

Avoid use of cache directory with pip. Use pip install --no-cache-dir <package>

• Dockerfile:21

Avoid additional packages by specifying --no-install-recommends

• Dockerfile:16

Delete the apt-get lists after installing something

• Dockerfile:16

pydantic.error_wrappers.ValidationError: 1 validation error for Msg 🛠

FastAPI will raise a ValidationError for the invalid response and set the field type. This can go wrong if the response model is not a pydantic model (or dataclass). When trying to produce the string representation of the exception, pydantic will try to produce the errors and fail because of the field type passed into the ValidationError not being a BaseModel or DataclassType. I am not sure if we need something like a ResponseValidationError to prevent this issue.

pydantic.error_wrappers.ValidationError: 1 validation error for Msg
response -> msg
  field required (type=value_error.missing)

• Schema.py

class Msg(BaseModel):
    msg: int

• Login.py

@router.post("/password-recovery/{email}", response_model=Msg)
def recover_password(email: str, db: Session = Depends(deps.get_db)) -> Any:
    """
    Password Recovery
    """
    user = user1.get_by_email(db, email=email)
    if not user:
        raise HTTPException(
            status_code=404,
            detail="The user with this username does not exist in the system.",
        )
    password_reset_token = generate_password_reset_token(email=email)
    return {"Message": "Password recovery email sent"}

• This is some reference Close to the same issue
  tiangolo/fastapi#1275
  tiangolo/fastapi#478

pydantic.error_wrappers.ValidationError: 1 validation error for blognote response -> autor

not sure if this is bug?:

pydantic.error_wrappers.ValidationError: 1 validation error for blognote
response -> autor

Refactor & Rebuild the Boilerplate

Fix 2 Maintainability issues in api\endpoints\login.py

CodeFactor found multiple issues:

Unnecessary "elif" after "raise"

• api\endpoints\login.py:92
• api\endpoints\login.py:38

API-Test : Create a Frontend UI with React 🚀

The API should communicate without errors with a simple React UI:

the basic usage is usable:

• Authenticate the new user
• Register a new user
• Edit User
• Logout (Working on it)

Unable to start the docker containers

Hello Yasser,

Thanks for this python API package, it looks really promising.

I was running through the following commands after cloning

        make pull
	make build
	make start 

Seeing this log on the app frdp container start

psycopg2.OperationalError: could not connect to server: Connection refused
        Is the server running on host "127.0.0.1" and accepting
        TCP/IP connections on port 5432?

The other services are running and here is the SS of services vs .env file setup.

psql shows the DB list in this way, for the lack of understanding on how to get postgres to work properly am merely looking for some insight. Any help is really appreciate-able.

No value for argument 'db' in unbound method call

Codacy detected an issue:

Message: No value for argument 'db' in unbound method call

Occurred on:

• Commit: b5804a0
• File: api/endpoints/login.py
• LineNum: 93
• Code: user = crud_user.CRUDUser.get_by_email(db, email=email)

Currently on:

• Commit: 336c565
• File: api/endpoints/login.py
• LineNum: 93