NEW

FastAPI .cursorrules prompt file guide

Code Style and Structure:

Follow PEP 8 guidelines for Python code style
Use meaningful variable and function names (snake_case for variables and functions, PascalCase for classes)
Keep functions small and focused on a single task
Use docstrings for modules, classes, and functions
Organize code into logical modules and packages
Use virtual environments for project isolation

Python-specific Conventions:

Prefer list comprehensions and generator expressions over map() and filter()
Use context managers (with statements) for resource management
Utilize decorators for cross-cutting concerns (e.g., logging, timing)
Leverage type hints for improved code readability and tooling support
Use f-strings for string formatting

Framework and API Development:

Use FastAPI as the primary framework for building high-performance APIs
Leverage FastAPI's automatic OpenAPI (Swagger) documentation
Utilize dependency injection for clean, testable code
Implement RESTful API design principles
Use Pydantic for data validation, serialization, and settings management
Define request and response models using Pydantic
Utilize Pydantic's BaseSettings for configuration management

Database and Data Modeling:

Use SQLModel, which combines SQLAlchemy core with Pydantic models
Leverage SQLModel's ability to use the same models for database tables and API schemas
Utilize SQLModel's async support for high-performance database operations
Implement database migrations using Alembic
Use connection pooling for efficient database connections
Implement proper indexing for frequently queried fields

Authentication and Security:

Implement JWT for stateless authentication
Use FastAPI's built-in security utilities
Use bcrypt for password hashing
Apply CORS policies using FastAPI's CORS middleware
Implement rate limiting for API endpoints (consider using FastAPI's dependencies for this)

Error Handling and Logging:

Use FastAPI's exception handlers for consistent error responses
Implement custom exception classes for application-specific errors
Use a logging framework (e.g., Python's built-in logging module)
Structure log messages for easy parsing and analysis

Frontend Development:

For server-side rendering, consider using FastAPI with Jinja2 templates
Implement responsive design using CSS frameworks (e.g., Bootstrap)
For single-page applications, use a JavaScript framework (e.g., React, Vue.js) that consumes your FastAPI backend

Testing:

Write unit tests using pytest
Implement integration tests for API endpoints using FastAPI's TestClient
Use factories (e.g., Factory Boy) for test data generation
Aim for high test coverage, especially for critical paths
Utilize Pydantic's parse_obj_as for easy test data creation

Asynchronous Processing:

Leverage FastAPI's asynchronous capabilities for concurrent processing
For background tasks, use FastAPI's background tasks feature or Celery for more complex scenarios
Implement message queues (e.g., RabbitMQ, Redis) for task management if needed

Deployment and DevOps:

Use Docker for containerization
Create optimized Dockerfiles for your FastAPI applications
Implement CI/CD pipelines (e.g., GitLab CI, GitHub Actions)
Use environment variables for configuration management
Utilize Pydantic's BaseSettings to load and validate environment variables
Implement health check endpoints for monitoring

Performance Optimization:

Leverage FastAPI's asynchronous capabilities for I/O-bound operations
Use caching mechanisms (e.g., Redis) for frequently accessed data
Implement database query optimization techniques with SQLModel
Profile code to identify and resolve bottlenecks

API Documentation:

Utilize FastAPI's automatic interactive API documentation (Swagger UI and ReDoc)
Keep API documentation up-to-date by maintaining accurate Pydantic models and FastAPI path operation functions

Version Control:

Use Git for version control
Implement feature branching and pull request workflows
Write meaningful commit messages

Dependencies Management

Use pip and requirements.txt for managing project dependencies
Consider using Poetry for more advanced dependency management

Remember to keep your code DRY (Don't Repeat Yourself), follow SOLID principles, and prioritize readability and maintainability in your Python full-stack development projects. Leverage the power of FastAPI, SQLModel, and Pydantic to create robust, type-safe, and high-performance applications.

stack:

FastAPI .cursorrules prompt file guide

Rohit Nair

NEW

C#, ASP.NET Core Best Practices .cursorrules prompt file

.NET Development Rules

You are a senior .NET backend developer and an expert in C#, ASP.NET Core, and Entity Framework Core.

Code Style and Structure

Write concise, idiomatic C# code with accurate examples.
Follow .NET and ASP.NET Core conventions and best practices.
Use object-oriented and functional programming patterns as appropriate.
Prefer LINQ and lambda expressions for collection operations.
Use descriptive variable and method names (e.g., 'IsUserSignedIn', 'CalculateTotal').
Structure files according to .NET conventions (Controllers, Models, Services, etc.).
Naming Conventions
Use PascalCase for class names, method names, and public members.
Use camelCase for local variables and private fields.
Use UPPERCASE for constants.
Prefix interface names with "I" (e.g., 'IUserService').
C# and .NET Usage
Use C# 10+ features when appropriate (e.g., record types, pattern matching, null-coalescing assignment).
Leverage built-in ASP.NET Core features and middleware.
Use Entity Framework Core effectively for database operations.
Syntax and Formatting
Follow the C# Coding Conventions (https://docs.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions)
Use C#'s expressive syntax (e.g., null-conditional operators, string interpolation)
Use 'var' for implicit typing when the type is obvious.
Error Handling and Validation
Use exceptions for exceptional cases, not for control flow.
Implement proper error logging using built-in .NET logging or a third-party logger.
Use Data Annotations or Fluent Validation for model validation.
Implement global exception handling middleware.
Return appropriate HTTP status codes and consistent error responses.
API Design
Follow RESTful API design principles.
Use attribute routing in controllers.
Implement versioning for your API.
Use action filters for cross-cutting concerns.
Performance Optimization
Use asynchronous programming with async/await for I/O-bound operations.
Implement caching strategies using IMemoryCache or distributed caching.
Use efficient LINQ queries and avoid N+1 query problems.
Implement pagination for large data sets.
Key Conventions
Use Dependency Injection for loose coupling and testability.
Implement repository pattern or use Entity Framework Core directly, depending on the complexity.
Use AutoMapper for object-to-object mapping if needed.
Implement background tasks using IHostedService or BackgroundService.
Testing
Write unit tests using xUnit, NUnit, or MSTest.
Use Moq or NSubstitute for mocking dependencies.
Implement integration tests for API endpoints.
Security
Use Authentication and Authorization middleware.
Implement JWT authentication for stateless API authentication.
Use HTTPS and enforce SSL.
Implement proper CORS policies.
API Documentation
Use Swagger/OpenAPI for API documentation (as per installed Swashbuckle.AspNetCore package).
Provide XML comments for controllers and models to enhance Swagger documentation.
Follow the official Microsoft documentation and ASP.NET Core guides for best practices in routing, controllers, models, and other API components.