Scala Dining

Cooking website.

Set-up

Local Python

• Create and activate an virtual environment
• Copy .env.example to .env and adjust as wanted
• pip install -r requirements.txt -r dev-requirements.txt
• python manage.py migrate
• python manage.py runserver

The app can also be built and run with Docker.

Development commands

• Lint code: flake8
• Blacken the code: black .
• Sort the imports: isort --ac .
• Run unit tests: python manage.py test
• Create superuser: python manage.py createsuperuser
• Coverage: coverage run manage.py test
  • Command line report: coverage report
  • Generate HTML report: coverage html

Dependencies

To add a new dependency, append it to requirements.in, install pip-tools inside the virtual environment and run pip-compile requirements.in. See pip-tools documentation for details.

Code style

The linter Flake8 expects the code, including docstrings, to follow the Google Python Style Guide. See the file .flake8 for the exact configuration.

To let PyCharm use the correct docstring format, change the setting at "Tools -> Python Integrated Tools -> Docstrings -> Docstring format" to Google.