demo refactor

Author: dakrauth

.coveragerc

@@ -34,10 +34,6 @@ pip-log.txt
 pip-delete-this-directory.txt
 
 # Unit test / coverage reports
-htmlcov/
-.tox/
-.coverage
-.coverage.*
 .cache
 nosetests.xml
 coverage.xml
@@ -55,7 +51,7 @@ docs/_build/
 
 # PyBuilder
 target/
-db.sqlite3
+demo.sqlite3
 .python-version
 venv
 .pylintrc

.gitignore

@@ -3,24 +3,25 @@ RUN apk --update add build-base bash jpeg-dev zlib-dev python3-dev
 
 ENV PYTHONUNBUFFERED 1
 ENV PYTHONDONTWRITEBYTECODE 1
-ENV DEMO_DB_NAME /db.sqlite3
-RUN pip install django-extensions
+ENV DJANGO_SETTINGS_MODULE demo.settings
+ENV PYTHONPATH /app
+ENV DEMO_DB_NAME /demo.sqlite3
+RUN pip install django-extensions pillow freezegun
 
-RUN mkdir -p /app
 WORKDIR /app
 
-COPY setup.py README.rst /app
+COPY pyproject.toml /app
 COPY picker /app/picker
 COPY demo /app/demo
 COPY tests /app/tests
 
 RUN pip install -e /app
-RUN pip install -e /app/demo/
-RUN demo migrate --no-input && \
-    demo loaddata demo/demo/fixtures/users.json && \
-    demo loaddata demo/demo/fixtures/picker.json && \
-    demo import_picks tests/nfl2024.json
+RUN django-admin migrate --no-input && \
+    django-admin loaddata /app/demo/fixtures/picker.json && \
+    django-admin import_picks /app/tests/nfl2024.json && \
+    django-admin import_picks /app/tests/quidditch.json && \
+    django-admin import_picks /app/tests/eng1.json
 
-EXPOSE 8080
+EXPOSE 8008
 RUN echo Load at http://localhost:8008
-CMD ["demo", "runserver", "0:8008"]
+CMD ["django-admin", "runserver", "0:8008"]

Dockerfile

@@ -6,6 +6,8 @@ DIST := DEV / "dist"
 VENV := DEV / "venv"
 BIN := VENV / "bin"
 PIP := BIN / "python -m pip --require-venv"
+DJENV := "DJANGO_SETTINGS_MODULE=demo.settings PYTHONPATH=."
+DJ := DJENV + " " + BIN / "django-admin"
 
 
 # Display recipe listing
@@ -19,29 +21,7 @@ info:
     @echo venv = {{VENV}}
     @echo bin = {{BIN}}
     @echo pip = {{PIP}}
-
-# Update all dev dependencies
-update:
-    @echo Installing picker ...
-    {{PIP}} install -U -e .
-
-    @echo Installing demo ...
-    {{PIP}} install -U -e demo/
-
-    @echo Installing dev dependencies ...
-    {{PIP}} install -U \
-        build \
-        pytest \
-        pytest-sugar \
-        pytest-clarity \
-        pytest-django \
-        freezegun \
-        coverage \
-        tox \
-        ipython \
-        flake8 \
-        black \
-        twine
+    @echo dj = {{DJ}}
 
 # Create a virtual environment if needed
 venv:
@@ -51,28 +31,43 @@ venv:
         python3 -m venv {{VENV}}
     fi 
 
+# Update all dev dependencies
+update: venv
+    @echo Installing picker ...
+    {{PIP}} install -U -e .
+    {{PIP}} install -U -e ".[test,dev]"
+
+# Setup the demo project for non-docker development
+demo-init:
+    {{DJ}} migrate --no-input
+    {{DJ}} loaddata demo/fixtures/picker.json
+    {{DJ}} import_picks tests/nfl2024.json tests/quidditch.json tests/eng1.json
+
+# Run the demo project in non-docker mode
+demo *args='':
+    {{DJ}} "$@"
+
 # Create virtual environment and install / update all dev dependencies
-init: info venv update
+init: info update demo-init
     @echo Initialization complete
 
 # Run test suite
 test *args='':
     {{BIN}}/pytest -vv -s --diff-width=60 "$@"
 
-# Run test suite
+# RE-run test suite with just previous failures
 retest:
     {{BIN}}/pytest -vv -s --diff-width=60 --lf
 
 # Run all tox tests
-test-all:
-    {{BIN}}/tox
+tox *args='':
+    {{BIN}}/tox "$@"
 
 # Run coverage report from test suite
 cov:
     -{{BIN}}/coverage run -m pytest -vv -s
     {{BIN}}/coverage report
     {{BIN}}/coverage html
-    echo HTML coverage report: {{DEV}}/coverage/index.html
 
 # Remove the virtual env dir
 rmvenv:
@@ -86,28 +81,33 @@ rmvenv:
 
 # Remove all *.pyc files and __pycache__ dirs
 clean:
+    find . -name .DS_Store -delete
     find . -type f -name "*.pyc" -delete
     find . -type d -name "__pycache__" -delete
 
 # Remove the dev directory, where all generated artifacts are stored
 clean-dev:
     rm -rf {{DEV}}
+    rm -f demo/demo.sqlite3
 
 # Remove all build and dist artifacts
 clean-build:
-    rm -rf ./picker.egg-info ./demo/demo.egg-info {{DIST}}/*
+    rm -rf {{DIST}}/*
+
+clean-eggs:
+    rm -rf ./picker.egg-info
 
 # Clean all build, test, and compile artifacts and remove venv
 [confirm('Remove all build, test, coverage, and compiled artifacts and delete venv?')]
-purge: clean clean-dev rmvenv clean-build
+purge: clean clean-dev rmvenv clean-build clean-eggs
     echo All artifacts purged
 
 # Build sdist and wheel files for distribution
 build:
     {{BIN}}/python -m build --outdir {{DIST}}
 
 # Build distros and upload to PyPI
-upload: clean-build build
+upload:
     twine upload {{DIST}}/*
 
 # Run linter and code formatter tools
@@ -119,14 +119,28 @@ lint:
     -{{BIN}}/black --check --diff -l 100 picker tests demo
 
 # Build the demo Docker container
-dbuild *args='':
+docker-build *args='':
     docker compose build "$@"
 
 # Run the Django server in a Docker container
-drun *args='':
-    @echo Browse to http://127.0.0.1:8080 when Docker is up
+docker-run *args='':
+    @echo Browse to http://127.0.0.1:8008 when Docker is up
     docker compose up "$@"
 
 # Execute a command in a running Docker container
-dexec *args='':
+docker-exec *args='':
     docker compose exec app "$@"
+
+# Execute a pip command in the local non-docker venv
+pip *args='':
+    {{PIP}} "$@"
+
+version arg="":
+    #!/usr/bin/env bash
+    if [ -z "${arg}" ]; then
+        grep -E "__version__ = \"[^\"]+\"" picker/__init__.py
+    else
+        sed -E "s/:Version: [0-9]+(\.[0-9]+)+/:Version: ${arg}/" README.rst
+        sed -E "s/__version__ = \"[^\"]+\"/__version__ = \"${arg}\"/" picker/__init__.py
+    fi
+

Justfile

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 David A Krauth
+Copyright (c) 2024 David A Krauth
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,10 +1,10 @@
-Picker
-======
+django-picker
+=============
 
 .. image:: https://github.com/dakrauth/picker/workflows/Test/badge.svg
     :target: https://github.com/dakrauth/picker/actions
 
-A Django-based sports picker app for various leagues.
+A Django-based sports picker app for various leagues (NFL, English Premier, etc).
 
 Templates
 ---------
@@ -44,8 +44,8 @@ Build and execute the demo in a Docker container:
 
 .. code-block:: bash
 
-    $ just dbuild
-    $ just drun
+    $ just docker-build
+    $ just docker-run
 
 To test:
 
@@ -64,8 +64,8 @@ To test:
 Meta
 ----
 
-Requires Python >= 3.10, Django >= 4.2
+:Version: 2.3.0
+:Requirements: Python >= 3.10, Django >= 4.2
+:License: MIT (see ``LICENSE`` file for more information)
+:Source: https://github.com/dakrauth/django-picker
 
-Distributed under the MIT License, see ``LICENSE`` file for more information.
-
-https://github.com/dakrauth/picker