Merge pull request #246 from profcalculus/django-todo-list

Source code steps for download

Author: gahjelle

django-todo-list/README.md

@@ -0,0 +1 @@
+Source files supporting the "Manage Your To-Do Lists Using Python and Django" step-by-step tutorial on Real Python.

django-todo-list/source_code_final/README.md

@@ -0,0 +1,19 @@
+# Django Todo List
+
+This folder contains project code for the _Real Python_ step-by-step project for building a to-do app with Django.
+
+## Setup Instructions
+
+These instructions have been tested in Ubuntu Linux and macOS. They should also work in Windows, but note that you'll need to use a different command to activate your virtual environment as described in Step 3. Please consult the [`venv` documentation](https://docs.python.org/3/library/venv.html#creating-virtual-environments) for greater detail on the use of virtual environments.
+
+1. Navigate into the project directory (`source_code/`).
+2. Create a virtual environment in a `venv/` folder by typing `python -m venv venv` in your console.
+3. Activate the venv using `source venv/bin/activate` (Linux, MacOS) or `venv\Scripts\activate.bat` (Windows).
+4. Install the dependencies with `python -m pip install -r requirements.txt`
+5. Generate the empty SQLite database and tables using `python manage.py migrate`
+5. Run the app with `python manage.py runserver`
+6. Browse to the [app home page](http://localhost:8000/) to see the list of todo lists, which will initially be empty. 
+
+You can now start using the UI to add your to-do lists and to-do items to the database. The data will be stored in a new `db.sqlite3` file in the root of your project directory.
+
+You can also use Django's auto-generated [admin interface](https://realpython.com/customize-django-admin-python/#setting-up-the-django-admin) at `http://localhost:8000/admin/` to view, add, and edit the data.

django-todo-list/source_code_final/manage.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "todo_project.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

django-todo-list/source_code_final/requirements.txt

@@ -0,0 +1,4 @@
+asgiref==3.4.1
+Django==3.2.9
+pytz==2021.3
+sqlparse==0.4.2

django-todo-list/source_code_final/todo_app/__init__.py

@@ -0,0 +1,7 @@
+# todo_list/todo_app/admin.py
+
+from django.contrib import admin
+from todo_app.models import ToDoItem, ToDoList
+
+admin.site.register(ToDoItem)
+admin.site.register(ToDoList)

django-todo-list/source_code_final/todo_app/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class TodoAppConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "todo_app"

django-todo-list/source_code_final/todo_app/apps.py

@@ -0,0 +1,37 @@
+# Generated by Django 3.2.9 on 2021-12-19 19:49
+
+from django.db import migrations, models
+import django.db.models.deletion
+import todo_app.models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='ToDoList',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.CharField(max_length=100, unique=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name='ToDoItem',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('title', models.CharField(max_length=100)),
+                ('description', models.TextField(blank=True, null=True)),
+                ('created_date', models.DateTimeField(auto_now_add=True)),
+                ('due_date', models.DateTimeField(default=todo_app.models.one_week_hence)),
+                ('todo_list', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='todo_app.todolist')),
+            ],
+            options={
+                'ordering': ['due_date'],
+            },
+        ),
+    ]

django-todo-list/source_code_final/todo_app/migrations/0001_initial.py

@@ -0,0 +1,38 @@
+# todo_list/todo_app/models.py
+from django.utils import timezone
+
+from django.db import models
+from django.urls import reverse
+
+
+def one_week_hence():
+    return timezone.now() + timezone.timedelta(days=7)
+
+
+class ToDoList(models.Model):
+    title = models.CharField(max_length=100, unique=True)
+
+    def get_absolute_url(self):
+        return reverse("list", args=[self.id])
+
+    def __str__(self):
+        return self.title
+
+
+class ToDoItem(models.Model):
+    title = models.CharField(max_length=100)
+    description = models.TextField(null=True, blank=True)
+    created_date = models.DateTimeField(auto_now_add=True)
+    due_date = models.DateTimeField(default=one_week_hence)
+    todo_list = models.ForeignKey(ToDoList, on_delete=models.CASCADE)
+
+    def get_absolute_url(self):
+        return reverse(
+            "item-update", args=[str(self.todo_list.id), str(self.id)]
+        )
+
+    def __str__(self):
+        return f"{self.title}: due {self.due_date}"
+
+    class Meta:
+        ordering = ["due_date"]