Marisco nbdev .cursorrules prompt file
About .cursorrules prompt file
What you can build
Python Code Quality Tool: Develop a web-based tool that analyzes Python code for adherence to PEP 8 style guidelines, checks for descriptive variable names, and validates the use of comments and docstrings following nbdev conventions. The tool could also provide suggestions for improving readability and maintainability.
IMFA Pattern Remapper App: Create an application that automates the process of remapping data provider nomenclatures to MARIS nomenclature using fuzzy matching algorithms. This app would guide users through inspecting, matching, fixing mismatches, and applying the lookup table to their dataframe, all facilitated by the
Remapper
object.Python Error Handling Advisor: Develop a web service that reviews Python code for error handling and input validation. The service would identify potential weak points in error handling, suggest informative exception usage, and recommend input validation improvements to avoid runtime errors.
Marisco Data Transformation Framework: Build an open-source library that leverages Marisco's architectural patterns, providing structured data management, callbacks for data transformations, and serializers for consistent output. The framework would allow users to manage data transformations using configuration files and ensure reproducibility.
Performance Optimization Analyzer: Design a tool that analyzes Python code for performance bottlenecks, suggesting vectorized operations, efficient algorithms, and caching techniques. This tool would aid developers in optimizing large dataset processing by identifying opportunities for function modularity and reusability.
Python Type Hinting Checker: Create a tool that scans Python codebases for missing or incorrect type hints in function signatures. This tool would assist developers in enhancing the clarity and usability of their code by ensuring proper type hinting throughout the project.
Benefits
- Comprehensive guidelines focus on Python, Marisco, and nbdev conventions to ensure quality and consistency.
- Detailed error handling and validation rules enhance robustness and prevent runtime errors.
- Performance optimization highlights efficient data processing and modular, reusable code for improved efficiency.
Synopsis
Python developers would benefit by building robust, maintainable, and high-performance Python applications adhering to specified coding standards and optimization techniques.
Overview of .cursorrules prompt
The .cursorrules file provides a set of guidelines and best practices that developers should follow when writing code, specifically for those working with Python, Marisco, and nbdev. It establishes rules for writing concise and readable code with proper documentation, emphasizing adherence to PEP 8 style standards. The file includes instructions on handling errors effectively, optimizing performance, and utilizing efficient data processing techniques. It incorporates the IMFA pattern for data remapping and outlines Marisco-specific architectural guidelines, promoting structured data management and code reproducibility. Additionally, the file includes formatting preferences for Python code, such as the use of single quotes, indentation size, and maximum line length.