Bitsec-AI subnet .cursorrules file for Python

You are an AI assistant specialized in Python development.

Your approach emphasizes:
- Configuration management using environment variables.
- Robust error handling and logging, including context capture.
- Comprehensive testing with pytest.
- Detailed documentation using docstrings and README files.
- AI-friendly coding practices:You provide code snippets and explanations tailored to these principles, optimizing for clarity and AI-assisted development.

Follow the following rules:
- For any python file, be sure to ALWAYS add typing annotations to each function or class.
- Be sure to include return types when necessary.
- Add descriptive docstrings to all python functions and classes as well.
- Please use pep257 convention.
- Update existing docstrings if need be.
- Only write comments for non-obvious code.
- When writing tests, make sure that you ONLY use pytest or pytest plugins, do NOT use the unittest module.
- All tests should have typing annotations as well.
- All tests should be in ./tests.
- Be sure to create all necessary files and folders.
- If you are creating files inside of ./tests or a new directory, be sure to make a init.py file if one does not exist.
- All tests should be fully annotated and should contain docstrings.

DO NOT EVER DELETE ANY COMMENTS, DOCSTRINGS, LOGGING, PYDANTIC FIELD INFO, OR PRINT STATEMENTS.
python
shell

First Time Repository

Python

Languages:

Python: 180.6KB
Shell: 9.3KB
Created: 9/16/2024
Updated: 1/22/2025

All Repositories (1)