djangox demo with things app

Author: adamowada

class-29/in-class-demo-djangox/.gitignore

@@ -0,0 +1,14 @@
+# OSX #
+.DS_Store
+
+# Byte-compiled / optimized / DLL files #
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Django #
+*.log
+db.sqlite3
+media
+
+.venv

class-29/in-class-demo-djangox/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Thank you for help improving DjangoX. All kinds of contributions are welcome. Please note that this starter project is *intentionally* basic: I don't plan to add environment variables, Docker, or other production-appropriate features as I feel they will overwhelm beginners. But I'm open to suggestions!
+
+Please submit an Issue or even better a PR and I'll review :)

class-29/in-class-demo-djangox/LICENSE

@@ -0,0 +1,24 @@
+djangox: Copyright (c) 2020 William Vincent
+django-allauth: Copyright (c) 2010 Raymond Penners and contributors
+cookie-cutter-django: Copyright (c) 2013-2020 Daniel Greenfeld
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

class-29/in-class-demo-djangox/README.md

@@ -0,0 +1,125 @@
+> A batteries-included Django starter project. To learn more try the books [Django for Beginners](https://djangoforbeginners.com), [Django for APIs](https://djangoforapis.com), and [Django for Professionals](https://djangoforprofessionals.com).
+
+## 🚀 Features
+
+- Django 4.1 & Python 3.10
+- Install via [Pip](https://pypi.org/project/pip/), [Pipenv](https://pypi.org/project/pipenv/), or [Docker](https://www.docker.com/)
+- User log in/out, sign up, password reset via [django-allauth](https://github.com/pennersr/django-allauth)
+- Static files configured with [Whitenoise](http://whitenoise.evans.io/en/stable/index.html)
+- Styling with [Bootstrap v5](https://getbootstrap.com/)
+- Debugging with [django-debug-toolbar](https://github.com/jazzband/django-debug-toolbar)
+- DRY forms with [django-crispy-forms](https://github.com/django-crispy-forms/django-crispy-forms)
+
+![Homepage](homepage_41.png)
+----
+
+## Table of Contents
+* **[Installation](#installation)**
+  * [Pip](#pip)
+  * [Pipenv](#pipenv)
+  * [Docker](#docker)
+* [Next Steps](#next-steps)
+* [Contributing](#contributing)
+* [Support](#support)
+* [License](#license)
+
+----
+
+## 📖 Installation
+DjangoX can be installed via Pip, Pipenv, or Docker. To start, clone the repo to your local computer and change into the proper directory.
+
+```
+$ git clone https://github.com/wsvincent/djangox.git
+$ cd djangox
+```
+
+### Pip
+
+```
+$ python -m venv .venv
+
+# Windows
+$ Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+$ .venv\Scripts\Activate.ps1
+
+# macOS
+$ source .venv/bin/activate
+
+(.venv) $ pip install -r requirements.txt
+(.venv) $ python manage.py migrate
+(.venv) $ python manage.py createsuperuser
+(.venv) $ python manage.py runserver
+# Load the site at http://127.0.0.1:8000
+```
+
+### Pipenv
+
+```
+$ pipenv install
+$ pipenv shell
+(.venv) $ python manage.py migrate
+(.venv) $ python manage.py createsuperuser
+(.venv) $ python manage.py runserver
+# Load the site at http://127.0.0.1:8000
+```
+
+### Docker
+
+To use Docker with PostgreSQL as the database update the `DATABASES` section of `django_project/settings.py` to reflect the following:
+
+```python
+# django_project/settings.py
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": "postgres",
+        "USER": "postgres",
+        "PASSWORD": "postgres",
+        "HOST": "db",  # set in docker-compose.yml
+        "PORT": 5432,  # default postgres port
+    }
+}
+```
+
+The `INTERNAL_IPS` configuration in `django_project/settings.py` must be also be updated:
+
+```python
+# config/settings.py
+# django-debug-toolbar
+import socket
+hostname, _, ips = socket.gethostbyname_ex(socket.gethostname())
+INTERNAL_IPS = [ip[:-1] + "1" for ip in ips]
+```
+
+And then proceed to build the Docker image, run the container, and execute the standard commands within Docker.
+
+```
+$ docker-compose up -d --build
+$ docker-compose exec web python manage.py migrate
+$ docker-compose exec web python manage.py createsuperuser
+# Load the site at http://127.0.0.1:8000
+```
+
+## Next Steps
+
+- Add environment variables. There are multiple packages but I personally prefer [environs](https://pypi.org/project/environs/).
+- Add [gunicorn](https://pypi.org/project/gunicorn/) as the production web server.
+- Update the [EMAIL_BACKEND](https://docs.djangoproject.com/en/4.0/topics/email/#module-django.core.mail) and connect with a mail provider.
+- Make the [admin more secure](https://opensource.com/article/18/1/10-tips-making-django-admin-more-secure).
+- `django-allauth` supports [social authentication](https://django-allauth.readthedocs.io/en/latest/providers.html) if you need that.
+
+I cover all of these steps in my three books: [Django for Beginners](https://djangoforbeginners.com), [Django for APIs](https://djangoforapis.com), and [Django for Professionals](https://djangoforprofessionals.com).
+
+----
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome! See [CONTRIBUTING.md](https://github.com/wsvincent/djangox/blob/master/CONTRIBUTING.md).
+
+## ⭐️ Support
+
+Give a ⭐️  if this project helped you!
+
+## License
+
+[The MIT License](LICENSE)

class-29/in-class-demo-djangox/accounts/__init__.py

@@ -0,0 +1,14 @@
+from django.contrib import admin
+from django.contrib.auth import get_user_model
+from django.contrib.auth.admin import UserAdmin
+
+from .forms import CustomUserCreationForm, CustomUserChangeForm
+from .models import CustomUser
+
+class CustomUserAdmin(UserAdmin):
+    add_form = CustomUserCreationForm
+    form = CustomUserChangeForm
+    model = CustomUser
+    list_display = ['email', 'username',]
+
+admin.site.register(CustomUser, CustomUserAdmin)

class-29/in-class-demo-djangox/accounts/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AccountsConfig(AppConfig):
+    default_auto_field = 'django.db.models.AutoField'
+    name = 'accounts'

class-29/in-class-demo-djangox/accounts/apps.py

@@ -0,0 +1,15 @@
+from django import forms
+from django.contrib.auth.forms import UserCreationForm, UserChangeForm
+from .models import CustomUser
+
+class CustomUserCreationForm(UserCreationForm):
+
+    class Meta(UserCreationForm.Meta):
+        model = CustomUser
+        fields = ('email', 'username',)
+
+class CustomUserChangeForm(UserChangeForm):
+
+    class Meta:
+        model = CustomUser
+        fields = ('email', 'username',)

class-29/in-class-demo-djangox/accounts/forms.py

@@ -0,0 +1,44 @@
+# Generated by Django 3.1.2 on 2020-10-01 13:52
+
+import django.contrib.auth.models
+import django.contrib.auth.validators
+from django.db import migrations, models
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CustomUser',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('password', models.CharField(max_length=128, verbose_name='password')),
+                ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
+                ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
+                ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')),
+                ('first_name', models.CharField(blank=True, max_length=150, verbose_name='first name')),
+                ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')),
+                ('email', models.EmailField(blank=True, max_length=254, verbose_name='email address')),
+                ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
+                ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
+                ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')),
+                ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.Group', verbose_name='groups')),
+                ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.Permission', verbose_name='user permissions')),
+            ],
+            options={
+                'verbose_name': 'user',
+                'verbose_name_plural': 'users',
+                'abstract': False,
+            },
+            managers=[
+                ('objects', django.contrib.auth.models.UserManager()),
+            ],
+        ),
+    ]

class-29/in-class-demo-djangox/accounts/migrations/0001_initial.py

@@ -0,0 +1,8 @@
+from django.contrib.auth.models import AbstractUser
+from django.db import models
+
+class CustomUser(AbstractUser):
+    pass
+
+    def __str__(self):
+        return self.email

class-29/in-class-demo-djangox/accounts/migrations/__init__.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

class-29/in-class-demo-djangox/accounts/models.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

class-29/in-class-demo-djangox/accounts/tests.py

@@ -0,0 +1,7 @@
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "django_project.settings")
+
+application = get_asgi_application()