About .cursorrules prompt file
What you can build
Flask API Generator: A web tool that automates the creation of scalable Flask APIs based on user input. Users can define endpoints, request/response schemas, and middleware, and the generator will produce a Flask project with proper structure and configuration.
API Performance Dashboard: A service that plugs into Flask applications to monitor and visualize API performance metrics like response time, throughput, and error rates in real-time, helping developers optimize their applications.
Flask Blueprints Marketplace: An online repository where developers can share and download reusable Flask Blueprints for common functionalities, such as user authentication, payment processing, or data analytics.
Flask Security Suite: A package providing ready-to-use security features for Flask applications, including JWT authentication, data validation, and rate limiting, all configurable via environment variables.
Flask Config Manager: A cloud-based tool for managing and deploying Flask application configurations across different environments (development, testing, production) using environment variables and version control.
Validator Factory for Flask: A Python library that allows Flask developers to quickly create and integrate custom data validation and error handling mechanisms tailored to specific application needs.
Flask Testing Automation Platform: A tool that generates unit test templates and integration test scenarios for Flask APIs using pytest and Flask's test client, streamlining the testing process.
Flask Deployment Assistant: A service that guides users through deploying Flask applications with proper logging, monitoring, and scalability features in cloud environments like AWS or Heroku.
OpenAPI Documenter for Flask: A plugin that integrates with Flask routes to automatically generate comprehensive Swagger/OpenAPI documentation with customizable request/response schemas and authentication details.
Flask Caching Optimizer: A system that provides suggestions for optimal caching strategies using Flask-Caching based on usage patterns and data access frequency, enhancing API performance.
Benefits
- Emphasizes modularity and iteration, discouraging code duplication and deeply nested structures for cleaner, maintainable code.
- Promotes error handling best practices with early returns and custom error types, improving code robustness.
- Utilizes Flask-specific techniques like blueprints and application factories to enhance modular development and testing.
Synopsis
Developers building scalable Flask APIs would benefit from this prompt, creating efficient, modular applications with robust error handling and comprehensive testing and documentation practices.
Overview of .cursorrules prompt
The .cursorrules file is designed for developers working with Python and Flask, focusing on principles and best practices for scalable API development. It emphasizes concise, technical Python examples, preferring functional programming and avoiding classes except for Flask views. Key principles include using descriptive variable names, iteration, modularization, and the RORO pattern. It covers error handling priorities, recommends essential dependencies like Flask-RESTful and Flask-JWT-Extended, and provides Flask-specific guidelines, such as application factory use, blueprint organization, and request lifecycle management. Additionally, it offers advice on performance optimization, key conventions on API structuring, testing with pytest, API documentation standards using Flask-RESTX or Flasgger, and deployment practices including logging and configuration with environment variables.
