Why

Regular project layout & its cons.

---

Let's look at the regular project folder layout.
There are serval function folders in the app, and the folders are arranged by functions, such as routes/models/services.
No problem if folders are set like this for small project.

But when it comes to large scale project which contains too many services and functions, it will bring tough task to maintain these codes, because those services' code files are existent in different folders, hard to review, you have to jumping among different folders.

Beyond the problem, developer also need to register some functions in main.py, such as router registering.

So it is ideal for developer to maintain each related functional code files in one container_name folder, and register all service and function codes into app automatically.

For the classical code layout:

Reference: https://github.com/eightBEC/fastapi-ml-skeleton/tree/master/fastapi_skeleton

    app
        router
            heartbeat.py
            prediction.py
        models
            heartbeat.py
            prediction.py
        services
            heartbeat.py
            prediction.py
        main.py

---

Ideal project layout & its pros.

---

Here is the ideal folder structure layout from developers' perspective. For each of service container_name(heartbeat and prediction), there is one module folder for containing all functional code files.

Furthermore, developers do not have to register function into app, such as router.

    app
        packages
            heartbeat
                router.py
                models.py
                service.py
            prediction
                router.py
                models.py
                service.py
        main.py