Scaffolding of a FLASK app for WhatsApp analytics #5
Conversation
| - id: trailing-whitespace | ||
| - id: end-of-file-fixer | ||
| - id: check-json | ||
| - id: check-yaml | ||
| - id: check-merge-conflict | ||
| - id: check-added-large-files |
There was a problem hiding this comment.
There are a few more hooks which can be helpful for our usecase
- flake8 - Purpose: Runs the Flake8 code linter to check for PEP 8 violations and other style issues.
- black - Purpose: Applies the Black code formatter to format Python code according to PEP 8 standards.
- isort - Purpose: Sorts import statements in Python files according to PEP 8 guidelines.
- mypy - Purpose: Runs the MyPy static type checker to find type errors in Python code.
- docformatter - Purpose: Formats docstrings in Python files to adhere to PEP 257 guidelines.
There was a problem hiding this comment.
Added a few more hooks in the pre-commit config.
There was a problem hiding this comment.
Was it helpful so far? @Sachinbisht27
There was a problem hiding this comment.
Yes, @Satendra-SR. For the code formatting and increasing readability of the code.
Sachinbisht27
changed the title
.github/workflows/pre-commit.yml
Outdated
| on: | ||
| pull_request: | ||
| push: | ||
| branches: [main] |
There was a problem hiding this comment.
Let's add develop branch as well
| 3. Activate the virtual environment | ||
| ```sh | ||
| source ./venv/bin/activate |
There was a problem hiding this comment.
Let's include Windows command as well. I believe we have different commands to active in MacOS vs Windows.
There was a problem hiding this comment.
Added command for win-os
README.md
Outdated
| 4. Install the dependencies: | ||
| ```sh | ||
| pip install -r requirements-dev.txt |
There was a problem hiding this comment.
Let's merge requirements-dev.txt and requirements.txt and use requirements.txt instead as there are only one additional package we are using in requirements-dev.txt
| - id: trailing-whitespace | ||
| - id: end-of-file-fixer | ||
| - id: check-json | ||
| - id: check-yaml | ||
| - id: check-merge-conflict | ||
| - id: check-added-large-files |
There was a problem hiding this comment.
Was it helpful so far? @Sachinbisht27
config.py
Outdated
| from dotenv import load_dotenv | ||
|
|
||
| load_dotenv() |
There was a problem hiding this comment.
Don't think we need this on cloud function. Can we out it under if condition? If ENV is development, then load this?
There was a problem hiding this comment.
Sure, @Satendra-SR Moved the load_dotenv() to the environment condition.
| # add your model's MetaData object here | ||
| # for 'autogenerate' support | ||
|
|
||
| target_metadata = models.Base.metadata |
There was a problem hiding this comment.
Can we try this?
target_metadata = db.metadata
api/utils/loggingutils.py
Outdated
| from api import app | ||
|
|
||
| logger = logging.getLogger() | ||
| logging.basicConfig(level=logging.DEBUG) |
There was a problem hiding this comment.
Can we get the logging level from ENV?
config.py
Outdated
| from os import path | ||
|
|
||
| from dotenv import load_dotenv | ||
|
|
||
| basedir = path.abspath(path.dirname(__file__)) | ||
| load_dotenv(path.join(basedir, ".env")) |
There was a problem hiding this comment.
| from os import path | |
| from dotenv import load_dotenv | |
| basedir = path.abspath(path.dirname(__file__)) | |
| load_dotenv(path.join(basedir, ".env")) | |
| from dotenv import load_dotenv | |
| load_dotenv() |
#3
Please complete the following steps and check these boxes before filing your PR:
Types of changes
Short description of what this resolves:
Added changes
Checklist: