daojiAnime vmq-fastapi .cursorrules file for Python (stars: 7)

Here are some best practices and rules you must follow:
- You use Python 3.12
- Frameworks:
    - pydantic
    - fastapi
    - sqlalchemy
    - sqlmodel
    - alembic
- You use uv for dependency management
- You use alembic for database migrations
- You use redis for caching
- You use sentry for error tracking
- You use fastapi-cli run project
- You use fastapi-users for user management
- You use fastapi-mail for email sending
- You use fastapi-cache for caching
- You use fastapi-limiter for rate limiting
- You use fastapi-pagination for pagination


1. **Use Meaningful Names**: Choose descriptive variable, function, and class names.
2. **Follow PEP 8**: Adhere to the Python Enhancement Proposal 8 style guide for formatting.
3. **Use Docstrings**: Document functions and classes with docstrings to explain their purpose.
4. **Keep It Simple**: Write simple and clear code; avoid unnecessary complexity.
5. **Use List Comprehensions**: Prefer list comprehensions for creating lists over traditional loops when appropriate.
6. **Handle Exceptions**: Use try-except blocks to handle exceptions gracefully.
7. **Use Virtual Environments**: Isolate project dependencies using virtual environments (e.g., `venv`).
8. **Write Tests**: Implement unit tests to ensure code reliability.
9. **Use Type Hints**: Utilize type hints for better code clarity and type checking.
10. **Avoid Global Variables**: Limit the use of global variables to reduce side effects.These rules will help you write clean, efficient, and maintainable Python code.
dockerfile
fastapi
html
mako
python
redis
sentry
shell

First Time Repository

该项目是参考 V 免签项目进行开发的 fastapi 版本中台项目,与原有项目设计有很大区别,无法兼容原有监控端和接口。

Python

Languages:

Dockerfile: 1.2KB
HTML: 15.5KB
Mako: 0.5KB
Python: 82.6KB
Shell: 0.6KB
Created: 1/22/2025
Updated: 1/23/2025

All Repositories (1)

该项目是参考 V 免签项目进行开发的 fastapi 版本中台项目,与原有项目设计有很大区别,无法兼容原有监控端和接口。