CursorPyProjectGuide is a comprehensive tool for generating a structured documentation and guideline framework for Python projects using the Cursor IDE. It provides tiered guidelines (core, advanced, supplemental) to cater to projects of varying complexity.
- Modular Guidelines: Choose between core, advanced, and supplemental rules to suit your project needs.
- Comprehensive Documentation: Generates a set of markdown files for documenting architectural decisions, best practices, lessons learned, and more.
- Automated Tool Integration: Recommends tools and practices for code quality, testing, and security.
- Versioning: Includes a versioning mechanism for tracking changes to the rules.
- Scalability and Security: Includes advanced security practices and scalability patterns.
To use CursorPyProjectGuide, clone this repository and run the script with the desired tier options, or just download the script and run it. It's that simple.
git clone https://github.com/hosteren/CursorPyProjectGuide.git
cd CursorPyProjectGuide
python create_cursor_rules.py core advanced supplementalRun the script with the desired tiers to generate the documentation structure:
python create_cursor_rules.py [tiers]core: Essential guidelines for all Python projects.advanced: Advanced practices for complex Python projects.supplemental: Specialized guidelines for specific contexts.
This project is licensed under the Apache License 2.0. See the LICENSE file for details.
- Inspired by the need for structured and modular guidelines in Python projects.
- Special thanks to the open-source community for continuous feedback and improvements.
- Thanks to Cursor for the amazing IDE and the ability to generate code with AI and a lot of willpower.
For any questions or suggestions, feel free to open an issue.
By using CursorPyProjectGuide, you can ensure that your Python projects are well-documented, follow best practices, and are adaptable to varying levels of complexity.