local_library_website

To-do-list

• Try RDBMS(Relational Database Management System):　SQLite, PostgreSQL
• For Doing Django Tutorial: The Local Library website steps by steps.
  • source codes
• Extend and prepare My skills to find some good web-backend/devops/architecture jobs.
• Practice system architecture design.
  • Update architecture with diagram
• Deploy methods survey
  • natively run on Linux host after activate virtual environment via "poetry shell"
    • run with django develeopment server
    • run with gunicorn
    • run with puff-rs
  • podmand run
  • k8s deploy
• Frontend
  • CSS work with Tailwind CSS
• Monitor and alert
  • Sentry
    • Rust Development at Sentry
    • self-hosted
    • Python Error and Performance Monitoring for Django web apps
    • Real-time crash reporting for your web apps, mobile apps, and games.
• Benchmark
  • Extreme HTTP Performance Tuning: 1.2M API req/s on a 4 vCPU EC2 Instance
  • Flame Graphs
  • wrk - a HTTP benchmarking tool

Prerequisites

• Linux host such as Arch Linux, Debian, Ubuntu, RHEL ...etc
• Python == 3.8.16
• pyenv+poetry
  • pyenv for Python versions control
  • poetry for Project dependency control
  • Project dependcy detialls will be in pyproject.toml/poetry.lock
• PostgreSQL == 15.3 or Django builtin SQLite
  • PostgreSQL 15.4 Documentation
  • PostgreSQL with docker
  • pacman directly install PostgreSQL on Arch Linux
• tree
  • a CLI tools to list contents of directories in a tree-like format.
• docker/podman (just pickup one to do conatiner image building and running)
• kind for create local Kubernetes clusters via docker/podman

Quick Start

#check out prerequisites to prepare your environment

#setting up for start postgresql on every bootup
sudo systemctl enable postgresql.service

#running postgresql server with this commands
#if everything is setting up!
sudo systemctl status postgresql.service

#spawns a virtual environment
poetry shell

#add packages
#src: https://python-poetry.org/docs/cli/#add
poetry add django
poetry add gunicorn
poetry add diagrams -G dev
poetry add django-environ==0.10.0

#remove packages
poetry remove diagrams
poetry remove django-environ

#for help
python3 manage.py help

#Creating a superuser for Django CMS system
python3 manage.py createsuperuser

#run devserver
python3 manage.py runserver


#check gunicorn
gunicorn --version
#run with gunicorn
#some test codes in misc
gunicorn --workers=2 test_gunicorn01:app
#run with django project
#src: https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/gunicorn/
gunicorn locallibrary.wsgi


#Warning: You'll need to run these commands every time your models change in a way that will affect the structure of the data that needs to be stored (including both addition and removal of whole models and individual fields).
python3 manage.py makemigrations
python3 manage.py migrate

#run test
python3 manage.py test
#Showing more test information
python3 manage.py test --verbosity 2
#Speeding things up
python3 manage.py test --parallel auto
#Running specific tests
python3 manage.py test catalog.tests.test_models
python3 manage.py test catalog.tests.test_views
python3 manage.py test catalog.tests.test_forms

#deploy check
python3 manage.py check --deploy

#Starts the Python interactive interpreter
python3 manage.py shell

#src: https://docs.python.org/3.8/library/sys.html#sys.path
#A list of strings that specifies the search path for modules. 
#Initialized from the environment variable PYTHONPATH, plus an installation-dependent default.
python -c "import sys; print(sys.path)"

#add env PYTHONPATH
export PYTHONPATH=/path/to/your/module:$PYTHONPATH

#add packages by poetry
poetry add "psycopg[binary,pool]"
poetry add django-environ

#add packages by poetry to extras section
poetry add diagrams --optional --extras diagrams

#export requirements.txt if needed
poetry export -f requirements.txt --output requirements.txt
poetry export -f requirements.txt --output requirements.txt --without-hashes

#podman comon operations
#login container registry such docker hub
podman login docker.io
podman images
podman container list --all
podman container rm local_library
podman rmi localhost/dev-test:latest

#docker/podman build container image
#docker build -t dev-test -f Dockerfile.dev
podman build --no-cache -t local_library_website/dev-test -f Dockerfile.dev
podman build -t docker.io/focal1119/local_library_website:dev -f Dockerfile.dev

#prod build
podman build -t docker.io/focal1119/local_library_website:prod -f Dockerfile.prod
podman build --no-cache -t docker.io/focal1119/local_library_website:prod -f Dockerfile.prod

#test docekr/podman container image in localhost when PostgreSQL is online
podman run -d --env-file=.env --name local_library -p 8000:8000 localhost/dev-test

#run with Dockerfile.dev
podman run -d --env-file=.env --name local_library -p 8000:8000 docker.io/focal1119/local_library_website:dev

#run with Dockerfile.prod
podman run -d --env-file=.env --name local_library -p 8000:8000 docker.io/focal1119/local_library_website:prod

#check logs
podman logs --follow local_library

#push
# docker push docker.io/focal1119/local_library_website:tagname
docker push docker.io/focal1119/local_library_website:dev
podman push docker.io/focal1119/local_library_website:dev
podman push docker.io/focal1119/local_library_website:prod

#pull
docker pull focal1119/local_library_website:dev

#.env.example for using and doing modification for your usecase
vim .env.example