Readme file updated along with other validations

[anasnadeemws]

Ticket Link

---

Related Links

---

Description

Readme file has been updated as more user-beginner friendly to get started with the template.
Environment variables check added on server startup
Removed unnecessary requirement in requirements.txt for faster setup for end user.
Fixed opentelemetry warning while running server

Steps to Reproduce / Test

---

---

Checklist

• PR description included
• pytest passes
• Tests are [changed or added]
• Relevant documentation is changed or added (and PR referenced)

GIF's

---

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
app
app.py	38	38	0%	1–70
app/config
__init__.py	3	1	67%	6
base.py	38	8	79%	29–36, 54–55
celery_config.py	17	17	0%	1–27
celery_utils.py	21	21	0%	1–30
redis_config.py	5	2	60%	8–9
app/constants
jwt_utils.py	16	11	31%	11–23
app/daos
home.py	10	5	50%	11–18
users.py	72	64	11%	12–136
app/middlewares
cache_middleware.py	51	51	0%	1–67
rate_limiter_middleware.py	25	25	0%	1–35
request_id_injection.py	17	17	0%	1–25
app/models
__init__.py	3	3	0%	1–5
users.py	27	27	0%	1–38
app/routes
__init__.py	12	12	0%	1–15
app/routes/cache_router
__init__.py	3	3	0%	1–5
cache_samples.py	12	12	0%	1–18
app/routes/celery_router
__init__.py	3	3	0%	1–5
celery_samples.py	12	12	0%	1–17
app/routes/home
__init__.py	3	3	0%	1–5
home.py	33	33	0%	1–45
app/routes/users
__init__.py	3	3	0%	1–5
users.py	38	38	0%	1–57
app/schemas/users
users_request.py	42	42	0%	1–73
users_response.py	10	10	0%	1–14
app/sessions
db.py	53	53	0%	1–82
app/tests
test_basic.py	20	16	20%	8–34
test_daos_home.py	23	10	57%	15–22, 28–37, 41
test_daos_users.py	110	95	14%	19–208
app/utils
exception_handler.py	19	19	0%	1–36
redis_utils.py	4	4	0%	1–7
slack_notification_utils.py	14	14	0%	1–32
user_utils.py	25	25	0%	1–36
app/wrappers
cache_wrappers.py	19	19	0%	1–24
TOTAL	818	716	12%

Tests	Skipped	Failures	Errors	Time
2	0 💤	0 ❌	2 🔥	0.559s ⏱️

[himanshu-wedensday]

how will it behave with .env.docker file Add a comment here please

[anasnadeemws]

Hey, I researched a bit and found out that each env file is unique.
And so by the previous '.env', your docker wouldn't work cause if you'll check your compose file it is .env.${environment_name} now in any case it will never be .env and docker won't work and so I've standardized it and fixed your docker error too.

Here's you can repro the uniqueness,
change your .env file to .env.local in your current code and run it.

Also there is a hierarchy of it:
Here's the priority of the files for the development build and the production build:
Dev.: (npm start): .env.development.local, .env.local, .env.development, .env
Prod.: (npm run build): .env.production.local, .env.local, .env.production, .env

And so by this .env.local is pretty standard and solves your compose problem too

[himanshu-wedensday]

same as above

[himanshu-wedensday]

revert it as it is dynamically get injected with active environment variable

[himanshu-wedensday]

same as previous

[himanshu-wedensday]

please move it to belkow line 7 so that all db config get together

[sonarqube-ws]

Analysis Details

0 Issues

• 0 Bugs
• 0 Vulnerabilities
• 0 Code Smells

Coverage and Duplications

• No coverage information (0.00% Estimated after merge)
• 0.00% Duplicated Code (0.00% Estimated after merge)

Project ID: wednesday-solutions_python-fastapi_AY434cJSB2n8RRmGoUoD

View in SonarQube

[himanshu-wedensday]

dont harcode. .env.local keep it .env.${environment_name} i mean to say this

[anasnadeemws]

Hey, for it take the environment name it has to go to .env file and for it to go to environment file it has to know the .env file.

It's not gonna work as it's a circular thing. We can have some sort of hack here tho but that's not gonna remain a standard base file

Also please go through the hierarchy pattern I've mentioned.

[himanshu-wedensday]

reference link please

[anasnadeemws]

https://stackoverflow.com/questions/55690143/what-is-the-difference-between-env-local-and-env-development-local