alex-oleshkevich / starlette_boot Goto Github PK

I'm going to share the idea that I had, which I didn't implement yet.

I want to have a very extensible tool, and I don't want to rely on static layouts. People may disagree with small things, and change their project structure, which would cause "naive" tools to fail. What I thought is to identify what I call "entities" in a project, and each entity has a metadata - and new custom entities can be created.

Let's go to an example. Assume we have the following project layout:

bootstrap/
├── app/
│   ├── __init.py__
│   ├── main.py
│   ├── config.py
│   └── database.py
└── Dockerfile

We would infer the entities on the project, and save it in a cache locally. Some entities I can see:

Entity: Application
Metadata: location (main.py), package (FastAPI/Starlette), middlewares

Entity: Configuration
Metadata: location (config.py), kind (BaseSettings, Starlette.config)

Entity: Database
Metadata: location database.py, kind (PostgreSQL, SQLite), package (SQLAlchemy, other)

Metadata can be more precise to make it easier to add plugins around it.

Then, if we have a Sentry plugin, it would interact with the Application entity, and include a middleware to the middleware metadata.

Another example, the alembic plugin, it would interact with the Database entity, and the entity that is in charge of startup command (?).

This is food for thoughts.