Finished models section of Django documentation.

Author: Noah Lloyd-Edelman

django.md

@@ -1,10 +1,13 @@
 # Django Notes
 
+https://docs.djangoproject.com/en/1.11/
+
 Abbreviation | Meaning
 --- | ---
 CM | Command
 PN | Project name
 AN | Application name
+MN | Model name
 EN | Virtualenv name
 PR | Project root folder
 AR | Application root folder
@@ -13,10 +16,10 @@ AR | Application root folder
 
 command | description
 --- | ---
-`django-admin <CM>` | These commands can be run anywhere, as long as the `virtualenv` is active.
-`python manage.py <CM>` | You must be in the same directory as this file to run it (app root)
+`django-admin CM` | These commands can be run anywhere, as long as the `virtualenv` is active.
+`python manage.py CM` | You must be in the same directory as this file to run it (app root)
 
-combine with one of the commands below:
+combine the above with one of the commands below
 
 command | description
 ---|----
@@ -30,20 +33,22 @@ dbshell | connects to the database |
 cleanup| cleans up the database
 
 ### shell_plus commands
+
 command|description
 --- | ---
-<MN>.objects.all() | Queries all model names and returns the results
-<MN>.objects.filter(id=#) | Filter an object's based on an attribute
-<MN>.objects.get(pk=#) | get a specific item
-q = <MN>(<model_field>="",) | Creates a new model which can be saved using `q.save()`
+MN.objects.all() | Queries all model names and returns the results
+MN.objects.filter(id=#) | Filter an object's based on an attribute
+MN.objects.get(pk=#) | get a specific item
+q = MN(<model_field>="",) | Creates a new model which can be saved using `q.save()`
+q.add(var), q.create(var), q.set(var) | add = add an object, create = make object, set = add multiple objects
 `import datetime` | Useful time management library
 `from django.utils import timezone` | Useful timezone conversion library
 
 ### Creating an app
 
 Command | What it does
 --- | ---
-`./manage.py startapp <AN>` | creates an app
+`./manage.py startapp AN` | creates an app
 `project_root/settings.py` | add the app to `INSTALLED_APPLICATIONS`
 `project_root/urls.py` | add the app urls
 
@@ -57,29 +62,102 @@ Command | What it does
 --- | ---
 `brew install python3` | Homebrew is a MacOS packager manager
 `pip install virtualenv virtualenvwrapper` | installs environment managing tool
-`mkvirtualenv <EN>` | create a virtual environment
-`workon <EN>` | boot up virtualenv
+`mkvirtualenv EN` | create a virtual environment
+`workon EN` | boot up virtualenv
 `pip install django` | django in the virtualenv
-`django-admin startproject <PN>` | creates the base project
+`django-admin startproject PN` | creates the base project
 `./manage-py runserver` | check if the server runs (must be in project root)
 
 ## Application folder
 
+### admin.py
+
+````
+from django.contrib import admin
+
+from .models import MN
+
+class MNInline(admin.TabularInline) admin.StackedInline # tabular = large blocks, stackedinline = single row per entry
+    model = MN
+    extra = #
+
+class MNAdmin(admin.ModelAdmin):
+    fieldset = [
+        (<title>, {'fields': ['field', 'field']}),
+        (<title>, {'fields': ['field', 'field']}),
+    ]
+    inlines = [MNInline] # Add outside model as inline
+    list_display = ('field', 'field', 'model_function') # columns to display for models
+    list_filter = ['field'] # sidebar filter
+    search_fields = ['field'] # searchbox for field
+
+admin.site.register(MN, MNAdmin)
+````
+
 ### models.py
 
+https://docs.djangoproject.com/en/1.11/topics/db/examples/
+
 ````
 from django.db import models
 
 
-class <ClassName>(models.Model):
-    var = models.CharField(max_length=5, default='aaa')
-    foreign_key = models.ForeignKey(<target_model>, on_delete=cascade)
-    
+class ClassName(models.Model):
+    SOME_CHOICES = (
+        ('X', 'XX'),
+        ('Y', 'YY'),
+        ('Z', 'ZZ'),
+    ) 
+    # L side goes into database / R for readability
+    # get_SOME_CHOICES_display() to show 2nd value
+
+    var = models.CharField(
+        "verbose name for field",
+        max_length=5,
+        default='aaa',
+        blank=True,
+        help_text='ahhhhhh',
+        unique=True,
+        )
+    var1 = models.CharField(
+        max_length=1, 
+        choices=SOME_CHOICES
+        )
+    foreign_key = models.ForeignKey(
+        <target_model>,
+        on_delete=models.CASCADE,
+        verbose_name='a related something',
+        )
+    many_to_many = models.ManyToManyField(<target_model>)
+    many_to_many = models.ManyToManyField(
+        <target_model>,
+        through='Intermediate table',
+        )
+
+    class Meta:
+        ordering = ['var']
+        verbose_name_plural = 'things'
+
     __str__(self)
         return self.var
-        
+
     def some_function(self):
         return self.somevar == timezone.now()
+
+    def get_absolute_url(self):
+        from django.urls import reverse
+        return reverse('model.views.view_name', args=[str(self.id)])
+
+# Abstract base model w/ child model
+class AbstractBaseModel(models.Model):
+    var = models.CharField(max_length=1)
+
+    class Meta:
+        abstract = true
+
+class AbstractChildModel(AbstractBaseModel):
+    var = models.CharField(max_length=1)
+
 ````
 
 ### urls.py
@@ -91,16 +169,31 @@ from . import views
 
 urlpatterns = [
     url(r'^$', views.index, name='index'),
+    url(r'(?P<pk>[0-9]+)/$', views.DetailView.as_view(), name='details'),
 ]
 ````
 
 ### views.py
 
 ````
 from django.http import HttpResponse
+from django.view import generic
 
 def index(request):
     return HttpResponse("Hello.")
+    
+def DetailView(generic.DetailView):
+    model = MN
+    template_name = 'AN/templates/AN/<file>.html'
+    
+    def get_queryset(self):
+        return MN.objects.filter(name='?')
+````
+
+### *.html
+
+````
+<a href="{{ object.get_absolute_url }}">{{ object.name }}</a>
 ````
 
 ## Project folder
@@ -114,11 +207,11 @@ from django.http import HttpResponseRedirect
 
 urlpatterns = [
     # e.g. myapp/
-    url(r'^<AN>/', include(<AN>.urls')),
+    url(r'^AN/', include(AN.urls')),
     # e.g. admin/
     url(r'^admin/', admin.site.urls),
     # e.g. /
-    url(r'^$', lambda r: HttpResponseRedirect('<AN>/')),
+    url(r'^$', lambda r: HttpResponseRedirect('AN/')),
 ]
 ````
 
@@ -127,7 +220,7 @@ urlpatterns = [
 ````
 INSTALLED_APPS = [
     'django_extensions',
-    '<AN>.apps.<AN>Config',
+    'AN.apps.ANConfig',
     'django.contrib.admin',
     'django.contrib.auth',
     'django.contrib.contenttypes',
@@ -137,10 +230,10 @@ INSTALLED_APPS = [
 ]
 ````
 
-
 ## Webstorm
 
 ### Setting up a server script
+
 `Languages > Frameworks > Django` - check enable django support
-The settings file is in `<PR>/<PF>/settings.py`
-You can edit your configurations in the top right. I recommend giving them names and only allowing single instances to run.
+The settings file is in `PR/PF/settings.py`
+You can edit your configurations in the top right. I recommend giving them names and only allowing single instances to run.