-
Notifications
You must be signed in to change notification settings - Fork 258
/
.cursorrules
1 lines (1 loc) · 1.4 KB
/
.cursorrules
1
Here are some best practices and rules you must follow:- You use Python 3.12- Frameworks: - pydantic - fastapi - sqlalchemy- You use poetry for dependency management- You use alembic for database migrations- You use fastapi-users for user management- You use fastapi-jwt-auth for authentication- 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 pagination1. **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.