Added basic documentation to all backend objects

src/interface/migrations/0001_initial.py

@@ -7,24 +7,29 @@ class Migration(migrations.Migration):
 
     initial = True
 
-    dependencies = [
-    ]
+    dependencies = []
 
     operations = [
         migrations.CreateModel(
-            name='Books',
+            name="Books",
             fields=[
-                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('title', models.CharField(max_length=255)),
-                ('author', models.CharField(max_length=255, null=True)),
-                ('categories', models.CharField(max_length=255, null=True)),
-                ('cover', models.BinaryField(editable=True, null=True)),
-                ('pages', models.IntegerField(null=True)),
-                ('progress', models.IntegerField(null=True)),
-                ('file_name', models.CharField(max_length=255)),
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("title", models.CharField(max_length=255)),
+                ("author", models.CharField(max_length=255, null=True)),
+                ("categories", models.CharField(max_length=255, null=True)),
+                ("cover", models.BinaryField(editable=True, null=True)),
+                ("pages", models.IntegerField(null=True)),
+                ("progress", models.IntegerField(null=True)),
+                ("file_name", models.CharField(max_length=255)),
             ],
-            options={
-                'db_table': 'books',
-            },
+            options={"db_table": "books",},
         ),
     ]

src/interface/models.py

@@ -0,0 +1,34 @@
+from django.db import models
+
+# Create your models here.
+
+
+class Books(models.Model):
+    """
+    pyShelfs Book Database class
+    :param title: Book title
+    :param author: Author
+    :param categories: Categories <-- Not implemented
+    :param cover: Cover image BinaryField
+    :param pages: # of pages <-- Not implemented
+    :param progress: Reader percentage <-- Not implented
+    :param file_name: Path to book
+    """
+
+    class Meta:
+        db_table = "books"
+
+    def __str__(self):
+        return self.title
+
+    title = models.CharField(max_length=255)
+    author = models.CharField(max_length=255, null=True)
+    categories = models.CharField(max_length=255, null=True)
+    cover = models.BinaryField(null=True, editable=True)
+    pages = models.IntegerField(null=True)
+    progress = models.IntegerField(null=True)
+    file_name = models.CharField(max_length=255, null=False)
+
+    def get_absolute_url(self):
+        """Returns the url to access a particular instance of MyModelName."""
+        return reverse("model-detail-view", args=[str(self.id)])