cheese

• A cheese index application

cheese is a basic demonstration of Django functionality using a Cookiecutter template.

Mirror repository

Table of Contents

• Features
• Installation
• Testing
• Application Demo
• Screenshots
• Reporting Bugs

---

Features

• Application
  • Add cheese entries with description, quality, and country of origin
  • Bootstrap4 & crispy-forms decorations
  • Customizable user profile pages with bio, profile pic, & country flags
  • For additional links to package resources used in this repository, see the Package Index
• Dev/testing
  • Basic module testing templates
  • Coverage reports on web.
  • Debug-toolbar available. See notes in config/settings.py for enabling.
  • Examples of using Factories & pytest fixtures in account app testing
  • shell_plus with IPython via django-extensions package
  • Pre-commit
  • Nox testing sessions for latest Python 3.10, 3.11, and 3.12
    • Sphinx documentation generation (nox -s docs)
    • linting (nox -s lint)
      • ruff
      • djlint
    • safety(python package vulnerability testing) (nox -s safety)
    • pytest sessions with pytest-cov &

---

Installation

• git clone https://github.com/kevinbowen777/cheese.git
• cd cheese
• Local installation:
  • poetry shell
  • poetry install
  • createdb cheeses (Requires Postgresql 15)
  • python manage.py migrate
  • python manage.py createsuperuser
  • python manage.py runserver
• Docker installation:
  • docker-compose up --build
  • docker-compose python manage.py migrate
  • docker-compose python manage.py createsuperuser
• Browse to http://127.0.0.1:8000 or http://127.0.0.1:8000/admin/
• Pre-commit:
  • To add the hook, run the following command in the poetry shell:
    • pre-commit install

---

Testing

• docker-compose exec web python manage.py test
• coverage run -m pytest
• Nox (includes sessions for coverage, lint, safety, tests)
  • testing supported for Python 3.10, 3.11, 3.12
  • e.g. nox, nox -rs lint-3.11, nox -s tests
    • nox
    • nox -s coverage-3.12
    • nox -s docs-3.11
    • nox -rs lint-3.10 (Use the 'r' flag to reuse existing session)
    • nox -s pyright-3.12
    • nox -s safety (will run tests against all Python versions)
    • nox -s tests

---

Application Demo

• TBD

---

Screenshots

---

Reporting Bugs

Visit the Issues page to view currently open bug reports or open a new issue.