Python .cursorrules Cursor AI Prompt File Guidelines

Python Guidelines .cursorrules prompt file

Jeff Coggshall

NEW

Python Guidelines .cursorrules prompt file

{
"cells": [
{
"cell_type": "code",
"execution_count": 1,
"metadata": {},
"outputs": [],
"source": [
"from improvements import uplevel1\n",
"from incontext import incontext1\n",
"from verbosity_style import lowish_verbosity\n",
"from acknowledgements import acknowledgement, acknowledgement_short\n",
"from use_documentation import use_docs"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"\n",
"When providing your response, always seek ways to uplevel the code:\n",
"\n",
"Consider the following:\n",
"1) What are other ways we could write this code? What are the pros and cons of those approaches?\n",
"\n",
"2) Think about this code from the perspective of an experienced system design engineer and platform architect. Are there any obvious improvements?\n",
"\n",
"3) Are there ways of refactoring this code to be more modular, readable, and robust that would make it easier to maintain and scale?\n",
"\n",
"4) What are common mistakes people make when writing code like this? Think of examples.\n",
"\n",
"You do not always need to provide these additional uplevel suggestions, but do consider them, and provide them when it is most appropriate.\n",
"\n",
"When making or proposing changes, always consider how the change will affect the other parts of the system.\n",
"Consider the entire context of the change. If you do not have all the necessary context, ask for it.\n",
"In particular, make sure that the other appropriate parts of the system are also changed if necessary for the change to work.\n",
"If you are not sure what the appropriate parts of the system are, ask, or at a minimum highlight anything that you think is highly likely to be affected.\n",
"\n",
"When suggesting or implementing code changes:\n",
"\n",
"1. Analyze system-wide impact:\n",
" - Consider how the proposed change may affect other components or modules.\n",
" - Evaluate potential side effects on functionality, performance, and dependencies.\n",
"\n",
"2. Understand the full context:\n",
" - If you lack complete information about the system architecture or related components, request additional context before proceeding.\n",
"\n",
"3. Ensure comprehensive modifications:\n",
" - Identify and update all relevant parts of the system affected by the change.\n",
" - Maintain consistency across interconnected components.\n",
"\n",
"4. Handle uncertainty:\n",
" - If unsure about which parts of the system may be impacted, either:\n",
" a) Ask for clarification, or\n",
" b) Clearly highlight areas you believe are likely to be affected, explaining your reasoning.\n",
"\n",
"5. Communicate implications:\n",
" - Clearly explain the rationale behind your proposed changes.\n",
" - Describe any potential risks or trade-offs associated with the modifications.\n",
"\n",
"If documentation is provided, make sure to use it.\n",
"\n",
"* Version Awareness: Be explicitly aware of version differences in APIs, platforms, and programming languages. When providing code or suggestions,always specify which version you're targeting and why. If documentation is provided, use that as your primary reference.\n",
"\n",
"* Best Practices Adherence: Ensure all code suggestions follow current best practices as outlined in official documentation or widely accepted community standards. Reference the documentation provided when possible.\n",
"\n",
"* Deprecation Checking: Actively check for and avoid using deprecated methods, attributes, or functions. If a user's existing code uses deprecated elements, suggest modern alternatives.\n",
"\n",
"No need to be too verbose though. Be clear, succinct, and to the point - focus on the most important information and actionable steps.\n",
"\n",
"Just to make sure that I know you've incorporated these instructions, please respond with at least one of the following emojis as appropriate at the very end of your response:\n",
"\n",
"✅ (Check Mark) - Signifying "Understood" or "Noted"\n",
"💡 (Light Bulb) - Indicating "I've grasped this concept"\n",
"🤔 (Thinking Face) - Indicating "I've considered this"\n",
"🧠 (Brain) - Indicating "I've included a substantial amount of additional appropriate information"\n",
"\n"
]
}
],
"source": [
"content = uplevel1 + "\n" + incontext1 + "\n" + use_docs + "\n" + lowish_verbosity + "\n\n" + acknowledgement_short\n",
"\n",
"print(content)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"\n",
"with open("cursor_rules.txt", "w") as f:\n",
" f.write(content)\n"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "py3124",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.12.4"
}
},
"nbformat": 4,
"nbformat_minor": 2
}

stack:

Python

Python Guidelines .cursorrules prompt file

Jeff Coggshall

About .cursorrules prompt file

What you can build

Code Review Platform - A web application designed to streamline code reviews by incorporating AI suggestions for code improvements, modularization, and error detection. This platform would assist developers by offering context-sensitive recommendations and ensuring best practices adherence.
System Impact Analyzer - A tool that helps identify potential system-wide impacts of code changes by evaluating dependencies and providing insights into how modifications affect interconnected components, helping developers make informed decisions.
Version Compatibility Checker - An app that checks code against different versions of APIs, platforms, and programming languages to ensure compatibility and suggest necessary adjustments, reducing the risk of deprecation issues.
Best Practices Educator - An educational website that offers interactive tutorials and documentation on coding best practices, helping developers improve their skills and adhere to the latest community standards.
Code Refactoring Assistant - A service that aids developers in refactoring their code for better readability, modularity, and robustness, including personalized suggestions for code organization and maintainability.
Comprehensive Change Tracker - A system that tracks changes across codebases to ensure consistency and update all relevant parts, maintaining cohesion in large and complex projects.
Documentation Utilizer - A platform designed to integrate with existing documentation systems, providing real-time suggestions based on documented best practices and API usage, enhancing development efficiency.
Risk and Trade-off Evaluator - An application that assists developers in evaluating potential risks and trade-offs associated with code changes, helping teams make balanced decisions regarding functionality and performance.
Interactive Coding Coach - A mentoring tool that offers AI-powered feedback and learning resources, focusing on common coding mistakes and offering solutions to improve coding habits.
Knowledge Sharing Hub - A community-driven platform for developers to share experiences and solutions related to system design, code refactoring, and best practices, fostering collaborative learning.

Benefits

Version Awareness: Emphasizes awareness of version differences in APIs, platforms, and languages, ensuring version-specific code suggestions.
Contextual Understanding: Encourages comprehensive understanding of system architecture to ensure modifications are accurately integrated and system-wide implications are considered.
Best Practices Adherence: Promotes adherence to current best practices and modern alternatives, avoiding deprecated elements for robust and sustainable development.

Synopsis

Developers can use this prompt to create and enhance Python coding guidelines and standards for better maintainability and scalability.

Overview of .cursorrules prompt

The .cursorrules file is designed for a programming environment in Python, providing guidelines and principles for enhancing, refactoring, and evaluating code. It imports specific modules to set rules for improving code quality, considering modularity, readability, and maintainability. It instructs users to anticipate the system-wide impact of proposed changes, communicate implications effectively, and adhere to best practices. Additionally, it emphasizes the importance of using provided documentation, being aware of version differences, and avoiding deprecated elements. It concludes with a prompt for users to acknowledge understanding via specific emojis.

Python Guidelines .cursorrules prompt file

Python Guidelines .cursorrules prompt file

Python Guidelines .cursorrules prompt file

About .cursorrules prompt file

What you can build

Benefits

Synopsis

Overview of .cursorrules prompt

Tags

Python Pytest Typer .cursorrules prompt file

Marisco nbdev .cursorrules prompt file

Pydantic Python Guide .cursorrules prompt file

Cursor AI setup using Python & OpenAI API .cursorrules prompt file

Python FastAPI TypeScript .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

Python FastAPI Scalable API .cursorrules prompt file

Flask-RESTful JWT RESTX .cursorrules prompt file

Cursor AI React TypeScript Shadcn UI .cursorrules prompt file

Next.js React TypeScript .cursorrules prompt file

Python Pytest Typer .cursorrules prompt file

Next.js Tailwind CSS Obsidian Plugin .cursorrules prompt file

Next.js TypeScript Clerk Stripe Vercel Setup .cursorrules prompt file

React TypeScript Care Project .cursorrules prompt file

Elixir Code Guidelines .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

SvelteKit TailwindCSS TypeScript .cursorrules prompt file

JavaScript TypeScript Code Quality .cursorrules prompt file

Plasticode Telegram API .cursorrules prompt file

ES Module Node.js Guidelines .cursorrules prompt file

Cursor Tip

Here is a quick example of leveraging the .cursorrules file (sys

Cursor Tip

Cursor Tip

Cursor Tip

Create a Chrome Extension Fast: Cursor AI Tutorial

Build ChatGPT with Python: Cursor AI Tutorial Guide

Build AI Voice Notes App: Cursor AI Tutorial Guide

Cursor AI Tutorial: Easy Loading Page with Shadcn Components