grooveshop django api

Grooveshop Django API

概述

本專案使用 Django 和 Django REST Framework 提供強大的無頭 API，並分別支援 Uvicorn (ASGI) 和 Gunicorn (WSGI) 促進的同步和非同步環境。它利用 Django Allauth 進行身份驗證，利用 Celery 和 Redis 進行任務管理，並利用 Postgres 進行資料儲存。功能包括快取、多語言支援和全面的測試覆蓋範圍。該 API 還包括一個內建的 Django 管理面板，用於高效的管理操作。

專案結構

該專案中的 Django 應用程式包括：

• 核心：核心功能和共享實用程式。
• 用戶：用戶管理和認證。
• 產品：產品目錄管理。
• 訂單：訂單處理和管理。
• 搜尋：進階搜尋功能。
• 滑桿：用於促銷和亮點的動態 UI 滑桿。
• 部落格：部落格文章的內容管理。
• SEO ：SEO 工具和配置。
• 提示：使用者提示和建議部分。
• VAT ：增值稅計算與管理。
• 國家/地區：特定於國家/地區的配置。
• 區域：區域數據和設定。
• 付款方式：支付方式配置。
• 會話：使用者會話管理。
• 購物車：購物車功能。
• 通知：使用者通知機制。
• 身份驗證：附加身份驗證層。
• 聯絡人：聯絡人管理和通訊工具。

特徵

• 身份驗證和使用者管理：簡化的使用者帳戶和會話管理。
• 多語言支援：支援多種語言，增強全球可用性。
• 進階搜尋和過濾：利用 Postgres 全文搜尋進行高效率的資料檢索。
• 任務排程：利用 Celery 進行後台任務管理。
• 效能優化：實作快取策略以提高 API 回應能力。
• 測試：包括全面的單元測試和整合測試。
• 管理面板：Django 的內建管理面板可直接管理。
• API 文件：使用 Swagger 和 Redoc 的記錄良好的 API。
• 容器化：Docker 整合以簡化設定和部署。

科技

• 框架：Django、Django REST 框架
• 身份驗證：Django Allauth
• 資料庫：PostgreSQL
• 任務管理：芹菜
• 訊息代理：Redis
• 伺服器設定：Uvicorn (ASGI)、Gunicorn (WSGI)
• 容器化：Docker

設定

先決條件

• Python 3.13 或更高版本
• Django 5.0 或更高版本
• PostgreSQL
• 雷迪斯

執照

該專案是根據 MIT 許可證開源的。有關更多詳細信息，請參閱許可證文件。

Django 專案的 Docker 命令

使用 Docker 組合

資料庫操作

• 運行資料庫遷移： docker compose run backend sh -c "python manage.py makemigrations --noinput"
• 應用程式遷移： docker compose run backend sh -c "python manage.py migrate"

使用者管理

• 建立超級使用者： docker compose run backend sh -c "python manage.py createsuperuser"

靜態文件

• 收集靜態檔案： docker compose run backend sh -c "python manage.py collectstatic --noinput"

測試和覆蓋範圍

• 運行測試： docker compose run backend sh -c "python manage.py test tests/"
• 執行覆蓋率測試（不包括特定檔案和資料夾）： docker compose run backend sh -c "coverage run --omit=*/migrations/*,*/management/*,*/manage.py,*/setup.py,*/asgi.py,*/wsgi.py --source='.' manage.py test tests/ && coverage report && coverage html"
• 產生覆蓋率 HTML 報告： docker compose run backend sh -c "coverage html"

數據播種

• 帶有虛假資料的種子資料庫： docker compose run backend sh -c "python manage.py seed_all"

自訂 Docker 撰寫文件

• 使用特定的 Compose 檔案運行： docker compose -f <docker-compose-file.yml> up -d --build

使用 Docker 執行

通用命令

• 在容器中執行指令： docker exec -it <container_id> <command>
• 執行特定的 Shell 指令： docker exec -it <container_id> sh -c "<command>"

本土化

• 產生區域設定訊息： docker exec -it <container_id> sh -c "python manage.py makemessages -l <locale>" docker exec -it <container_id> sh -c "python manage.py makemessages --all --ignore=env"
• 編譯區域設定訊息： docker exec -it <container_id> sh -c "python manage.py compilemessages --ignore=env"

開發工具的附加配置

芹菜

啟動芹菜服務

• 使用 Django 資料庫調度程式執行本機 Celery 節拍調度程式： celery -A core beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler
• 執行 Celery 工作程式： celery -A core worker -E -l info --pool=solo
• 用 Flower 監控 celery ： celery -A core flower --broker=amqp://guest:guest@localhost:5672// --broker_api=http://guest:guest@localhost:15672/api// --port=5555

獨角獸

運行 ASGI 應用程式

• 啟動 Uvicorn for ASGI 應用程式： uvicorn asgi:application --port 8000 --workers 4 --log-level debug --reload

Python 開發設定和實用程式

Python 版本 3.13.1

虛擬環境管理

• 安裝 Virtualenv ： pip install virtualenv
• 建立虛擬環境： virtualenv <env_name>
• 啟動虛擬環境：
  • Unix/Linux： source <env_name>/bin/activate
  • Windows： <env_name>Scriptsactivate
• 停用虛擬環境： deactivate
• 安裝要求： pip install -r requirements.txt
• 安裝環境特定要求： pip install -r requirements/<env_name>.txt

Django 命令

• 安裝 Django ： pip install django
• 啟動一個新專案： django-admin startproject <project_name>
• 啟動一個新應用程式： python manage.py startapp <app_name>
• 資料庫遷移與管理：
  • 進行遷移： python manage.py makemigrations
  • 應用程式遷移： python manage.py migrate
  • 刷新資料庫： python manage.py sqlflush
  • 使用種子資料填入資料庫（單一工廠範例）： python manage.py factory_seed --model="BlogPost" --count="100"
  • 使用種子資料填入資料庫（所有工廠範例）： python manage.py seed_all --model-counts="Country=10,Product=100"
• 管理用戶：
  • 建立超級使用者： python manage.py createsuperuser
• 管理靜態檔案： python manage.py collectstatic
• 測試和調試：
  • 運行測試： python manage.py test
  • 存取 Django shell： python manage.py shell
  • 增強的 shell： python manage.py shell_plus
  • 資料庫 shell： python manage.py dbshell
• 運行開發伺服器： python manage.py runserver

程式碼格式化和 Linting

• 導航到來源目錄： cd src
• 預提交和黑色格式：
  • 安裝預提交掛鉤： pre-commit install
  • 執行預提交掛鉤： pre-commit run --all-files
  • 用黑色格式化程式碼： black .

依賴管理的詩歌

• 安裝 Poetry ：Unix/Linux： curl -sSL https://install.python-poetry.org | python3 - Windows： (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -
• 管理專案和相依性：
  • 建立一個新專案： poetry new <project_name>
  • 安裝依賴項： poetry install
  • 新增或刪除依賴項： poetry add <dependency_name>和poetry remove <dependency_name>
  • 更新特定依賴項或鎖定檔案： poetry update <dependency_name>和poetry lock
  • 執行腳本： poetry run <script_name>
  • 進入虛擬環境shell： poetry shell

如何自動pip升級requirements.txt

• 使用 pip-upgrader ：
• 運行 pip-upgrader ： pip-upgrade

草莓 GraphQL

• 安裝草莓： pip install strawberry-graphql
• 運行草莓伺服器： strawberry server
• 使用專案架構運行： strawberry server core.graphql.schema:schema

Django REST 框架 - 壯觀

• 產生 API 模式： python manage.py spectacular --color --file schema.yml

Git 指令用法

標籤管理

刪除標籤

• 刪除遠端標籤：

  • 刪除所有遠端標籤： git tag -l | xargs -n 1 git push --delete origin

• 刪除本機標籤：

  • 刪除所有本機標籤： git tag -l | xargs git tag -d