- pixshare - A Django web application for users to bookmark and share images
-
Application
- TBD
-
Dev/testing
- Basic module testing templates
- Coverage reports on web
- Debug-toolbar available. See notes in
config/settings.py
for enabling. - shell_plus with IPython via django-extensions package
- Pre-commit
- 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
) - safety(python package vulnerability testing) (
nox -s safety
) - pytest sessions with
pytest-cov &
pytest-django (
coverage run -m pytest
)
- coverage (
-
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 withalias run=./run
in your~/.bash_aliases
or equivalent file. Then you'll be able to runrun
instead of./run
.
git clone https://github.com/kevinbowen777/pixshare.git
cd django_start
- 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 build --build-arg "ENV=DEV"
(include testing/dev dependencies)docker compose build --build-arg "ENV=PROD"
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
- To add the hook, run the following command in the poetry shell:
docker compose exec web python manage.py test
coverage run -m pytest
- Nox (includes sessions for black, lint, 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 black-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
- TBD
TBD
Visit the Issues page to view currently open bug reports or open a new issue.