add comic

Author: FuzzyGrim

src/app/forms.py

@@ -274,6 +274,18 @@ class Meta(MediaForm.Meta):
             "repeats": "Number of Rereads",
         }
 
+class ComicForm(MediaForm):
+    """Form for comics."""
+
+    class Meta(MediaForm.Meta):
+        """Bind form to model."""
+
+        model = models.Comic
+        labels = {
+            "progress": "Progress (Issues)",
+            "repeats": "Number of Rereads",
+        }
+
 
 class TvForm(MediaForm):
     """Form for TV shows."""

src/app/helpers.py

@@ -31,6 +31,7 @@ def tailwind_to_hex(tailwind_color):
 
     return tailwind_colors.get(tailwind_color)
 
+
 def minutes_to_hhmm(total_minutes):
     """Convert total minutes to HH:MM format."""
     hours = int(total_minutes / 60)
@@ -74,8 +75,9 @@ def get_media_verb(media_type, past_tense):
         "movie": ("watch", "watched"),
         "anime": ("watch", "watched"),
         "manga": ("read", "read"),
-        "book": ("read", "read"),
         "game": ("play", "played"),
+        "book": ("read", "read"),
+        "comic": ("read", "read"),
     }
     return verbs[media_type][1 if past_tense else 0]
 

src/app/migrations/0038_comic_historicalcomic_and_more.py

@@ -0,0 +1,106 @@
+# Generated by Django 5.1.7 on 2025-04-05 12:17
+
+import app.mixins
+import django.core.validators
+import django.db.models.deletion
+import simple_history.models
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('app', '0022_item_source_squashed_0037_alter_item_media_type'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Comic',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('score', models.DecimalField(blank=True, decimal_places=1, max_digits=3, null=True, validators=[django.core.validators.DecimalValidator(3, 1), django.core.validators.MinValueValidator(0), django.core.validators.MaxValueValidator(10)])),
+                ('progress', models.PositiveIntegerField(default=0)),
+                ('status', models.CharField(choices=[('Completed', 'Completed'), ('In progress', 'In Progress'), ('Repeating', 'Repeating'), ('Planning', 'Planning'), ('Paused', 'Paused'), ('Dropped', 'Dropped')], default='Completed', max_length=20)),
+                ('repeats', models.PositiveIntegerField(default=0)),
+                ('start_date', models.DateField(blank=True, null=True)),
+                ('end_date', models.DateField(blank=True, null=True)),
+                ('notes', models.TextField(blank=True, default='')),
+            ],
+            options={
+                'ordering': ['-score'],
+                'abstract': False,
+            },
+            bases=(app.mixins.CalendarTriggerMixin, models.Model),
+        ),
+        migrations.CreateModel(
+            name='HistoricalComic',
+            fields=[
+                ('id', models.BigIntegerField(auto_created=True, blank=True, db_index=True, verbose_name='ID')),
+                ('score', models.DecimalField(blank=True, decimal_places=1, max_digits=3, null=True, validators=[django.core.validators.DecimalValidator(3, 1), django.core.validators.MinValueValidator(0), django.core.validators.MaxValueValidator(10)])),
+                ('progress', models.PositiveIntegerField(default=0)),
+                ('status', models.CharField(choices=[('Completed', 'Completed'), ('In progress', 'In Progress'), ('Repeating', 'Repeating'), ('Planning', 'Planning'), ('Paused', 'Paused'), ('Dropped', 'Dropped')], default='Completed', max_length=20)),
+                ('repeats', models.PositiveIntegerField(default=0)),
+                ('start_date', models.DateField(blank=True, null=True)),
+                ('end_date', models.DateField(blank=True, null=True)),
+                ('notes', models.TextField(blank=True, default='')),
+                ('history_id', models.AutoField(primary_key=True, serialize=False)),
+                ('history_date', models.DateTimeField(db_index=True)),
+                ('history_change_reason', models.CharField(max_length=100, null=True)),
+                ('history_type', models.CharField(choices=[('+', 'Created'), ('~', 'Changed'), ('-', 'Deleted')], max_length=1)),
+            ],
+            options={
+                'verbose_name': 'historical comic',
+                'verbose_name_plural': 'historical comics',
+                'ordering': ('-history_date', '-history_id'),
+                'get_latest_by': ('history_date', 'history_id'),
+            },
+            bases=(simple_history.models.HistoricalChanges, models.Model),
+        ),
+        migrations.RemoveConstraint(
+            model_name='item',
+            name='app_item_source_valid',
+        ),
+        migrations.RemoveConstraint(
+            model_name='item',
+            name='app_item_media_type_valid',
+        ),
+        migrations.AlterField(
+            model_name='item',
+            name='media_type',
+            field=models.CharField(choices=[('tv', 'TV Show'), ('season', 'TV Season'), ('episode', 'Episode'), ('movie', 'Movie'), ('anime', 'Anime'), ('manga', 'Manga'), ('game', 'Game'), ('book', 'Book'), ('comic', 'Comic')], default='movie', max_length=10),
+        ),
+        migrations.AlterField(
+            model_name='item',
+            name='source',
+            field=models.CharField(choices=[('tmdb', 'The Movie Database'), ('mal', 'MyAnimeList'), ('mangaupdates', 'MangaUpdates'), ('igdb', 'Internet Game Database'), ('openlibrary', 'Open Library'), ('comicvine', 'Comic Vine'), ('manual', 'Manual')], max_length=20),
+        ),
+        migrations.AddConstraint(
+            model_name='item',
+            constraint=models.CheckConstraint(condition=models.Q(('source__in', ['tmdb', 'mal', 'mangaupdates', 'igdb', 'openlibrary', 'comicvine', 'manual'])), name='app_item_source_valid'),
+        ),
+        migrations.AddConstraint(
+            model_name='item',
+            constraint=models.CheckConstraint(condition=models.Q(('media_type__in', ['tv', 'season', 'episode', 'movie', 'anime', 'manga', 'game', 'book', 'comic'])), name='app_item_media_type_valid'),
+        ),
+        migrations.AddField(
+            model_name='comic',
+            name='item',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='app.item'),
+        ),
+        migrations.AddField(
+            model_name='comic',
+            name='user',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AddField(
+            model_name='historicalcomic',
+            name='history_user',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AddConstraint(
+            model_name='comic',
+            constraint=models.UniqueConstraint(fields=('item', 'user'), name='app_comic_unique_item_user'),
+        ),
+    ]

src/app/models.py

@@ -44,6 +44,7 @@ class Sources(models.TextChoices):
     MANGAUPDATES = "mangaupdates", "MangaUpdates"
     IGDB = "igdb", "Internet Game Database"
     OPENLIBRARY = "openlibrary", "Open Library"
+    COMICVINE = "comicvine", "Comic Vine"
     MANUAL = "manual", "Manual"
 
 
@@ -58,6 +59,7 @@ class MediaTypes(models.TextChoices):
     MANGA = "manga", "Manga"
     GAME = "game", "Game"
     BOOK = "book", "Book"
+    COMIC = "comic", "Comic"
 
 
 class Colors(models.TextChoices):
@@ -1173,3 +1175,9 @@ class Book(Media):
     """Model for books."""
 
     tracker = FieldTracker()
+
+
+class Comic(Media):
+    """Model for comics."""
+
+    tracker = FieldTracker()

src/app/providers/comicvine.py

@@ -0,0 +1,221 @@
+from bs4 import BeautifulSoup
+from django.conf import settings
+from django.core.cache import cache
+
+from app.providers import services
+
+base_url = "https://comicvine.gamespot.com/api"
+headers = {
+    "User-Agent": "Mozilla/5.0",
+}
+
+
+def search(query):
+    """Search for comics on Comic Vine."""
+    cache_key = f"search_comicvine_{query}"
+    data = cache.get(cache_key)
+
+    if data is None:
+        params = {
+            "api_key": settings.COMICVINE_API,
+            "format": "json",
+            "query": query,
+            "resources": "volume",
+            "field_list": "id,name,image",
+            "limit": 20,
+        }
+
+        response = services.api_request(
+            "ComicVine",
+            "GET",
+            f"{base_url}/search/",
+            params=params,
+            headers=headers,
+        )
+
+        data = [
+            {
+                "media_id": str(item["id"]),
+                "source": "comicvine",
+                "media_type": "comic",
+                "title": item["name"],
+                "image": get_image(item),
+            }
+            for item in response["results"]
+        ]
+
+        cache.set(cache_key, data)
+
+    return data
+
+
+def comic(media_id):
+    """Return the metadata for the selected comic volume from Comic Vine."""
+    cache_key = f"comicvine_volume_{media_id}"
+    data = cache.get(cache_key)
+
+    if data is None:
+        params = {
+            "api_key": settings.COMICVINE_API,
+            "format": "json",
+            "field_list": (
+                "publisher,site_detail_url,name,last_issue,image,issues,"
+                "description,concepts,start_year,count_of_issues,people,"
+            ),
+        }
+
+        response = services.api_request(
+            "ComicVine",
+            "GET",
+            f"{base_url}/volume/4050-{media_id}/",
+            params=params,
+            headers=headers,
+        )
+
+        response = response.get("results", {})
+        publisher_id = response["publisher"]["id"]
+        recommendations = []
+        if publisher_id:
+            recommendations = get_similar_comics(publisher_id, media_id)
+
+        data = {
+            "media_id": media_id,
+            "source": "comicvine",
+            "source_url": response["site_detail_url"],
+            "media_type": "comic",
+            "title": response["name"],
+            "max_progress": get_last_issue_number(response),
+            "image": get_image(response),
+            "synopsis": get_synopsis(response),
+            "genres": get_genres(response),
+            "details": {
+                "start_date": get_start_year(response),
+                "publisher": get_publisher_name(response),
+                "issues_count": get_issues_count(response),
+                "last_issue_name": get_last_issue_name(response),
+                "last_issue_number": get_last_issue_number(response),
+                "people": get_people(response),
+            },
+            "related": {
+                "from_the_same_publisher": recommendations,
+            },
+        }
+
+        cache.set(cache_key, data)
+
+    return data
+
+
+def get_readable_status(status):
+    """Convert API status to readable format."""
+    status_map = {
+        None: "Unknown",
+        "": "Unknown",
+        "Completed": "Completed",
+        "Ongoing": "Ongoing",
+    }
+    return status_map.get(status, "Unknown")
+
+
+def get_image(response):
+    """Return the image URL."""
+    if "image" in response:
+        return response["image"]["medium_url"]
+    return settings.IMG_NONE
+
+
+def get_synopsis(response):
+    """Return the synopsis."""
+    if "description" not in response:
+        return "No synopsis available"
+
+    soup = BeautifulSoup(response["description"], "html.parser")
+    text = soup.get_text(separator=" ")
+    return " ".join(text.split())
+
+
+def get_genres(response):
+    """Return the list of genres."""
+    if "concepts" in response:
+        return [concept["name"] for concept in response["concepts"]]
+    return None
+
+
+def get_start_year(response):
+    """Return the start year of the comic volume."""
+    return response.get("start_year")
+
+
+def get_publisher_name(response):
+    """Return the publisher name of the comic volume."""
+    publisher = response.get("publisher")
+    if publisher and isinstance(publisher, dict):
+        return publisher.get("name")
+    return None
+
+
+def get_issues_count(response):
+    """Return the count of issues in the comic volume."""
+    return response.get("count_of_issues")
+
+
+def get_last_issue_name(response):
+    """Return the name of the last issue in the comic volume."""
+    last_issue = response.get("last_issue")
+    if last_issue and isinstance(last_issue, dict):
+        return last_issue.get("name")
+    return None
+
+
+def get_last_issue_number(response):
+    """Return the last issue number."""
+    last_issue = response.get("last_issue")
+    if last_issue and isinstance(last_issue, dict):
+        return int(last_issue.get("issue_number"))
+    return None
+
+
+def get_people(response):
+    """Return the people associated with the comic volume."""
+    people = response.get("people", [])
+    return [person["name"] for person in people[:5] if isinstance(person, dict)]
+
+
+def get_similar_comics(publisher_id, current_id, limit=10):
+    """Get similar comics from the same publisher."""
+    cache_key = f"comicvine_similar_{publisher_id}_{current_id}"
+    data = cache.get(cache_key)
+
+    if data is None:
+        params = {
+            "api_key": settings.COMICVINE_API,
+            "format": "json",
+            "field_list": "id,name,image,start_year,publisher",
+            "filter": f"publisher:{publisher_id}",
+            "limit": limit + 1,  # Get one extra to account for current comic
+        }
+
+        response = services.api_request(
+            "ComicVine",
+            "GET",
+            f"{base_url}/volumes/",
+            params=params,
+            headers=headers,
+        )
+
+        # Filter out the current comic and format the response
+        data = [
+            {
+                "media_id": str(item["id"]),
+                "source": "comicvine",
+                "media_type": "comic",
+                "title": item["name"],
+                "image": get_image(item),
+            }
+            for item in response["results"]
+            if str(item["id"]) != current_id
+        ][:limit]
+
+        cache.set(cache_key, data)
+
+    return data