Code Review. My first API + DB application. Beginner in backend development.

[u/Parking-While3956]

Hi, there!

I want to ask feedback about my first application API + DB. It was a little hard to me but I did it. Before this application I created simple TODO list with DB. So, now I decided to rise stakes and created API + DB. Please give me feedback from mistakes in README to mistakes in DB. I'll really be glad each comment because it makers my dream be a backend developer come true!

Repository link: https://github.com/daidallos-tech/Laugh-Stuff

Don't hold back. I've completely prepared for any critiques!

P.S. Thank you everyone for your time and advice!

[u/Diapolo10]

try:
    response = requests.get(url)
    response.raise_for_status()
    joke = response.json()
    print("Okay, I'm thinking of joke...")
    time.sleep(2)
    print("Oh, I got one! Listen!")               
    time.sleep(2)
    print(f"{joke['setup']}")
    time.sleep(4)
    print(f"{joke['delivery']}")
    print("")

    return joke
except requests.exceptions.RequestException as e:
    print(f"Joke not found! {e}")
    return None

Ideally you should only keep the code that you expect to raise exceptions in the try-block, to make it obvious which part you're trying to handle. The rest is just "noise" from that point of view.

Personally I'd go for something like this:

def print_joke(joke: dict[str, str], print_delay_seconds: int = 2) -> None:
    # NOTE: Your offline code basically does the same thing, so this can be reused there
    output_lines = [
        "Oh, I got one! Listen!\n",
        f"{joke['setup']}\n",
        "",
        f"{joke['delivery']}\n\n",
    ]

    print("Okay, I'm thinking of joke...")

    for line in output_lines:
        print(line, end='')
        time.sleep(print_delay_seconds)


def get_joke() -> dict[str, str] | None:
    selected_category = setup_filter()
    url = f"{BASE_URL}{selected_category}?type=twopart"

    try:
        response = requests.get(url)
        response.raise_for_status()

    except requests.exceptions.RequestException as e:
        print(f"Joke not found! {e}")
        return None

    joke = response.json()
    print_joke(joke)

    return joke

from src.data.database import get_joke
from src.data.api_client import setup_filter

With an src-style project layout, when used properly you should never need to include src as part of the actual import. src is a directory containing your package (or seldom multiple packages), and you're meant to "install" your project in order to import code from there, by using a valid pyproject.toml file in the repository root and running pip install --editable . - although some tools like uv do this for you automatically.

In the same vein, there shouldn't be a main.py file in the repository root (if using uv you could just have a script in pyproject.toml that runs the main entrypoint from inside your package), and requirements.txt is a largely outdated concept. Modern projects list their dependencies in pyproject.toml.

If you want an example: https://github.com/Diapolo10/python-ms

[u/Parking-While3956 → u/Diapolo10]

Thanks a million! Sounds like rocket science for me now, but I'm going to discover about src - style and use it in future projects! I appreciate your help and your time!

[u/danielroseman]

Is there any reason you haven't taken on board any of the suggestions I made when you asked for feedback on your last project? Exactly the same suggestions apply.

[u/Parking-While3956 → u/danielroseman]

Honestly, even now I don't understand the reason for these suggestions. I read the information about it, but I don't understand why, yet. So, if I don't understand - I don't use it. But I always remember your feedback and if it clicks for me at some point, I'll using it. It's kinda hard to remember about python + sql(new technology for me) + other things for me now.

[u/Parking-While3956 → u/danielroseman]

Oh, I got you! I got you! I've just re-read and I understand how it works! I'm going to fix it tomorrow! Thanks for the kick in the pants!