CharlieKC/issue3

.pre-commit-config.yaml

@@ -0,0 +1,57 @@
+exclude: '^docs/|/migrations/'
+default_stages: [commit]
+
+repos:
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v4.4.0
+ hooks:
+ - id: trailing-whitespace
+ - id: end-of-file-fixer
+ - id: check-json
+ - id: check-toml
+ - id: check-xml
+ - id: check-yaml
+ - id: debug-statements
+ - id: check-builtin-literals
+ - id: check-case-conflict
+ - id: check-docstring-first
+ - id: detect-private-key
+
+ - repo: https://github.com/adamchainz/django-upgrade
+ rev: '1.15.0'
+ hooks:
+ - id: django-upgrade
+ args: ['--target-version', '4.2']
+
+ - repo: https://github.com/asottile/pyupgrade
+ rev: v3.13.0
+ hooks:
+ - id: pyupgrade
+ args: [--py311-plus]
+
+ - repo: https://github.com/psf/black
+ rev: 23.9.1
+ hooks:
+ - id: black
+
+ - repo: https://github.com/PyCQA/isort
+ rev: 5.12.0
+ hooks:
+ - id: isort
+
+ - repo: https://github.com/PyCQA/flake8
+ rev: 6.1.0
+ hooks:
+ - id: flake8
+
+ - repo: https://github.com/Riverside-Healthcare/djLint
+ rev: v1.34.0
+ hooks:
+ - id: djlint-reformat-django
+ - id: djlint-django
+
+# sets up .pre-commit-ci.yaml to ensure pre-commit dependencies stay up to date
+ci:
+ autoupdate_schedule: weekly
+ skip: []
+ submodules: false

flashcards/admin.py

@@ -1,16 +1,19 @@
 from django.contrib import admin
+
 from .models import Conversation, Message
 
+
 class MessageInline(admin.TabularInline):
  model = Message
  extra = 0 # Number of empty forms to display
- readonly_fields = ['created_at'] # Fields to display as read-only
+ readonly_fields = ["created_at"] # Fields to display as read-only
+
 
+@admin.register(Conversation)
 class ConversationAdmin(admin.ModelAdmin):
  inlines = [MessageInline]
- list_display = ['id', 'user', 'created_at', 'updated_at']
- readonly_fields = ['user', 'created_at', 'updated_at']
+ list_display = ["id", "user", "created_at", "updated_at"]
+ readonly_fields = ["user", "created_at", "updated_at"]
 
 
-admin.site.register(Conversation, ConversationAdmin)
 admin.site.register(Message)

flashcards/asgi.py

@@ -11,6 +11,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'flashcards.settings')
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "flashcards.settings")
 
 application = get_asgi_application()

flashcards/migrations/0001_initial.py

@@ -5,29 +5,41 @@
 
 
 class Migration(migrations.Migration):
-
  initial = True
 
- dependencies = [
- ]
+ dependencies = []
 
  operations = [
  migrations.CreateModel(
- name='Conversation',
+ name="Conversation",
  fields=[
- ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
- ('created_at', models.DateTimeField(auto_now_add=True)),
- ('updated_at', models.DateTimeField(auto_now=True)),
+ ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+ ("created_at", models.DateTimeField(auto_now_add=True)),
+ ("updated_at", models.DateTimeField(auto_now=True)),
  ],
  ),
  migrations.CreateModel(
- name='Message',
+ name="Message",
  fields=[
- ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
- ('text', models.TextField()),
- ('role', models.CharField(choices=[('user', 'User'), ('assistant', 'Assistant'), ('system', 'System')], default='user', max_length=10)),
- ('created_at', models.DateTimeField(auto_now_add=True)),
- ('conversation', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='messages', to='flashcards.conversation')),
+ ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+ ("text", models.TextField()),
+ (
+ "role",
+ models.CharField(
+ choices=[("user", "User"), ("assistant", "Assistant"), ("system", "System")],
+ default="user",
+ max_length=10,
+ ),
+ ),
+ ("created_at", models.DateTimeField(auto_now_add=True)),
+ (
+ "conversation",
+ models.ForeignKey(
+ on_delete=django.db.models.deletion.CASCADE,
+ related_name="messages",
+ to="flashcards.conversation",
+ ),
+ ),
  ],
  ),
  ]

flashcards/migrations/0002_conversation_user.py

@@ -6,17 +6,18 @@
 
 
 class Migration(migrations.Migration):
-
  dependencies = [
  migrations.swappable_dependency(settings.AUTH_USER_MODEL),
- ('flashcards', '0001_initial'),
+ ("flashcards", "0001_initial"),
  ]
 
  operations = [
  migrations.AddField(
- model_name='conversation',
- name='user',
- field=models.ForeignKey(default='1', on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
+ model_name="conversation",
+ name="user",
+ field=models.ForeignKey(
+ default="1", on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL
+ ),
  preserve_default=False,
  ),
  ]

flashcards/models.py

@@ -1,19 +1,21 @@
-from django.db import models
 from django.contrib.auth.models import User
+from django.db import models
+
 
 class Conversation(models.Model):
  user = models.ForeignKey(User, on_delete=models.CASCADE)
  created_at = models.DateTimeField(auto_now_add=True)
  updated_at = models.DateTimeField(auto_now=True)
 
+
 class Message(models.Model):
  ROLE_CHOICES = [
- ('user', 'User'),
- ('assistant', 'Assistant'),
- ('system', 'System'),
+ ("user", "User"),
+ ("assistant", "Assistant"),
+ ("system", "System"),
  ]
 
- conversation = models.ForeignKey(Conversation, related_name='messages', on_delete=models.CASCADE)
+ conversation = models.ForeignKey(Conversation, related_name="messages", on_delete=models.CASCADE)
  text = models.TextField()
- role = models.CharField(max_length=10, choices=ROLE_CHOICES, default='user')
+ role = models.CharField(max_length=10, choices=ROLE_CHOICES, default="user")
  created_at = models.DateTimeField(auto_now_add=True)