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