- git clone https://github.com/zabit923/PA-DGU.git
- create .env file in ./src
.env file example:
POSTGRES_DB=YOUR_DB
POSTGRES_USER=postgres
POSTGRES_PASSWORD=YOUR_DB_PASS
DB_HOST=database
DB_PORT=5432
DEBUG=False
SECRET_KEY=YOUR_SECRET
RESET_PASSWORD_TOKEN_SECRET=YOUR_RESET_PASSWORD_TOKEN_SECRET
VERIFICATION_TOKEN_SECRET=YOUR_VERIFICATION_TOKEN_SECRET
EMAIL_HOST_USER=YOUR_EMAIL_HOST_USER
EMAIL_HOST_PASSWORD=YOUR_EMAIL_HOST_PASSWORD
- docker-compose up -d
| Tools | Description |
|---|---|
isort |
isort your python imports for you so you don't have to. isort is a Python utility / library to sort imports alphabetically, and automatically separated into sections. |
black |
Black is the uncompromising Python code formatter. By using it, you agree to cede control over minutiae of hand-formatting. In return, Black gives you speed, determinism, and freedom from pycodestyle nagging about formatting. You will save time and mental energy for more important matters. Blackened code looks the same regardless of the project you're reading. Formatting becomes transparent after a while and you can focus on the content instead. Black makes code review faster by producing the smallest diffs possible. |
pre-commit |
Git hooks allow you to run scripts any time you want to commit or push. This lets us run all of our linting and tests automatically every time we commit/push. Git hook scripts are useful for identifying simple issues before submission to code review. We run our hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements. By pointing these issues out before code review, this allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks. |
For more information on Project Styling check out the detailed guide 👉 How to set up a perfect Python project