kevinbowen777 / learning-log

An Django web application for creating learning lists

Learning Log

Learning Log is an online journal system that lets you keep track of information you’ve learned about particular topics. Learning log is built using the Django 5.0.x web framework.

It allows users to log the topics they’re interested in and to make journal entries as they learn about each topic. Once logged in, a user can create new topics, add new entries, and read and edit existing entries.

Table of Contents

• Features
• Installation
• Testing
• Application Demo
• Screenshots
• Reporting Bugs

---

Features

• Application

  • Create & edit new topics and entries
  • User registration with email verification & social(GitHub) login using django-allauth
  • Bootstrap4 & crispy-forms decorations
  • Customizable user profile pages with bio, profile pic, & country flags
  • For additional links to package resources used in this repository, see the Package Index

• Dev/testing

  • Basic module testing templates
  • Coverage reports on web
  • Debug-toolbar available. See notes in config/settings.py for enabling.
  • Examples of using Factories & pytest fixtures in account app testing
  • shell_plus with IPython via django-extensions package
  • Nox testing sessions for latest Python 3.10, 3.11, and 3.12
    • coverage (nox -s coverage)
    • Sphinx documentaion generation (nox -s lint)
    • linting (nox -s lint)
      • ruff
      • djlint
    • safety(python package vulnerability testing) (nox -s safety)
    • pytest sessions with pytest-cov & pytest-django (coverage run -m pytest)

• run command menu

  (adapted from Nick Janetakis' helpful docker-django-example)

  You can run ./run to get a list of commands and each command has documentation in the run file itself. This comes in handy to run various Docker commands because sometimes these commands can be a bit long to type.

  If you get tired of typing ./run you can always create a shell alias with alias run=./run in your ~/.bash_aliases or equivalent file. Then you'll be able to run run instead of ./run.

---

Installation

• git clone https://github.com/kevinbowen777/learning_log.git
• cd learning_log
• Local installation:
  • poetry shell
  • poetry install
  • python manage.py migrate
  • python manage.py createsuperuser
  • python manage.py runserver
• Docker installation:
  • docker compose up --build
  • docker compose exec web python manage.py migrate
  • docker compose exec web python manage.py createsuperuser Additional commands:
    • docker compose exec web python manage.py shell_plus (loads Django shell autoloading project models & classes)
    • docker run -it django-start-web bash (CLI access to container)
• Browse to http://127.0.0.1:8000 or http://127.0.0.1:8000/resources/
• Pre-commit:
  • To add the hook, run the following command in the poetry shell:
    • pre-commit install

---

Testing

• docker compose exec web python manage.py test
• coverage run -m pytest
• Nox (includes sessions for black, lint, typing, safety, tests)
  • testing supported for Python 3.10, 3.11, 3.12
  • e.g. nox, nox -rs lint-3.11, nox -s tests
    • nox
    • nox -s coverage-3.12
    • nox -s docs-3.11
    • nox -rs lint-3.10 (Use the 'r' flag to reuse existing session)
    • nox -s pyright-3.11
    • nox -s safety (will run tests against all Python versions)
    • nox -s tests

---

Application Demo

A live application demonstration:

TBD

---

Screenshots

Home Page

Topic List

Topic Entries

Profile Page

Email Validation

Password Reset

Lost Password Request

---

Reporting Bugs

Visit the Issues page to view currently open bug reports or open a new issue.

learning-log's Issues

Write tests for learning_logs app

Add pagination for topics & entries

Update project issue labels

Install Django debug toolbar

Install django-debug-toolbar

---

• package source
• documentation

1. poetry add -D django-debug-toolbar

2. There are three separate configurations to set in our config/settings.py file:

• INSTALLED_APPS
• Middleware
• INTERNAL_IPS

2a. Add to INSTALLED_APPS

# config/settings.py
INSTALLED_APPS = [
    'django.contrib.admin',
    ...
    'django.contrib.sites',

    # Third-party
    'debug_toolbar', # new

    # Local
    'accounts',
    'pages',
    'books',
]

2b. Add to MIDDLEWARE section:

# config/settings.py
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    ...
    'debug_toolbar.middleware.DebugToolbarMiddleware', # new
]

2c. Add the following lines at the bottom of config/settings.py.:

# django-debug-toolbar
import socket
# Use the following in Docker only:                                     
# INTERNAL_IPS = [ip[:-1] + "1" for ip in ips]                                  
# The following is for use locally:                                             
INTERNAL_IPS = ["127.0.0.1"]

3. Update URLconf:

# config/urls.py
if settings.DEBUG: # new
    import debug_toolbar
    urlpatterns = [
        path('__debug__/', include(debug_toolbar.urls)),
    ] + urlpatterns

Create CustomUser model

Add nox for testing

Setup Sphinx documentation

Rename users dir to accounts

Reduce width of login & signup fields

Currently, the width of login and signup fields spans most of the width of the page.

We can reduce the width using the class parameter in the form. For example:

<form class="col-md-6" method="post">                                         
  {% csrf_token %}                                                            
  {{ form|crispy }}                                                           
  <button class="btn btn-success" type="submit">Log In</button>               
</form> 

See Example: Stacked-to-horizontal section here: https://getbootstrap.com/docs/3.4/css/#grid-example-basic

Migrate db URL to .env

Create initial functional test template

Implement django-allauth

Application is currently using basic auth. Convert to using allauth for additional functionality

Create user profile with bio, pic & country

Move pre-commit dependencies to Poetry

Break pages tests into separate model, form, view modules

Install pre-commit hooks

Adjust size of user/password fields

Improve navbar

Upgrade to Safety v2.0.0

Configure media/file uploads

Reduce date size for topic entries

Migrate to Docker postgres

Create Dockerfile & docker-compose files

Adjust flake8 & black line length settings

Add favicon.ico

Set up Nox for 3.11 testing

Add env template

Update pre-commit yaml with new exclusions

Break learning_log tests into separate model, form, view modules

Update README install instructions

Override allauth email & password templates

Create new template to match our theme and override the default django-allauth templates for the following:

templates/account/email.html
templates/account/email_confirm.html
templates/account/password_change.html
templates/account/password_reset.html
templates/account/password_reset_done.html
templates/account/password_reset_from_key.html
templates/account/password_reset_from_key_done.html

Move flake8 configs to .flake8 file

Add & configure django-countries

Add pagination to topics list

Break tests into separate model, form, view modules

Add button style to 'Add new entry'

Install shell_plus

Upgrade to Django 4.0.6

Add pyenv version for 3.8, 3.9 testing

Allow for deletion & editing and archiving of topics

Add five standard test user accounts w/profile set up

Install & configure pytest & coverage

Rename index.html to home & move to template root

Upgrade to Django 4.0.5

Adjust size of new topic & entry fields

Add basic tests

Create pages app

Add django-crispy-forms

Add friendly name to containers

Add pagination to entry lists