Python GitHub Setup .cursorrules prompt file
About .cursorrules prompt file
What you can build
- Automated File Organization Service:
- An online service that uses AI models for content analysis and intelligently classifies and organizes files in a user's cloud storage based on predefined categories.
- AI-Powered Document Management System:
- A comprehensive document management platform for businesses, using AI to classify and organize documents, with integration to services like Google Drive or Dropbox.
- File Classification and Analysis Tool:
- A desktop application using AI to classify and organize files based on content, offering detailed insights and analytics to users about their stored documents.
- AI-Based Content Analyzer API:
- Provide an API for developers to integrate content classification and analysis capabilities into their applications using the libraries mentioned.
- Python Library for File Organization:
- Develop a Python library that makes use of existing libraries like
watchdog
andspacy
to offer developers an easy-to-use toolkit for file classification and management.
- AI-Assisted File Management Mobile App:
- A mobile application that uses AI to help users organize files and documents stored both locally and in the cloud, offering a user-friendly interface.
- Document Auto-Tagging System for Enterprises:
- Enterprise-grade software that automates the tagging and metadata assignment for documents and files stored enterprise-wide, utilizing AI for accurate classification.
- Content Organization SaaS Platform:
- A SaaS platform catering to small businesses requiring content classification and organization for large sets of documents, with collaboration and sharing capabilities.
- AI-Enhanced Digital Filing Cabinet:
- Create a virtual filing cabinet application that uses AI to simulate traditional filing systems but categorizes and retrieves documents using advanced AI-powered methods.
AI File Sorting Plugin for IDEs:
- Develop a plugin for popular Integrated Development Environments (IDEs) to provide developers assistance in sorting and organizing project files using AI.
Interactive AI File Organizing Dashboard:
- An interactive dashboard that visually represents users' document organization while providing AI suggestions to improve file hierarchy and management.
Intelligent File Organization Chatbot:
- A conversational chatbot that assists users with file organization tasks by understanding commands and executing file classification jobs in a conversational format.
Open Source File Classification Extension:
- A community-driven open-source extension to existing file storage systems (like Nextcloud) that provides AI-based file organization features.
AI-Powered Data Import Tool:
- A specialized tool for importing data from various formats, utilizing AI to classify and structure incoming files accordingly.
Benefits
- Comprehensive coding style guidelines including strict usage, indentation, and max line length, ensuring consistency and readability.
- Strong emphasis on testing, requiring 80% coverage with unit and integration tests, boosting software robustness.
- Detailed error handling, security protocols, and configuration management practices enhancing application reliability and security.
Synopsis
Developers building Python-based AI file organization tools would benefit from this prompt to ensure code quality, security, and consistency.
Overview of .cursorrules prompt
The .cursorrules file provides a comprehensive configuration for a Python-based project. It outlines the coding style, naming conventions, and error handling practices to ensure code quality and consistency. The file specifies that the code should be well-commented, tested, and documented according to the Google Python Style Guide. Emphasis is placed on security, configuration management, and version control, recommending Git with GitHub Flow branching strategy. It also includes guidelines for logging, monitoring, dependency management, and accessibility, with CI/CD set up via GitHub Actions. The architecture promotes modular design and principles like DRY and Single Responsibility. Project-specific settings like testing with pytest and manual deployment strategies are included. This file aims to provide a coherent structure and best practices for developing a Python-based AI tool for file organization and content analysis.