@patrickjs/python-github-setup-cursorrules-prompt-file

# Python GitHub Setup Cursor Rules

This .cursorrules file is currently empty in the source repository.

For more information, visit: https://github.com/PatrickJS/awesome-cursorrules

## Suggested Python GitHub Setup Rules

### Project Structure
- Use a standard Python project structure (src/, tests/, docs/)
- Include a comprehensive README.md with setup instructions
- Add a .gitignore file for Python projects
- Include requirements.txt or pyproject.toml for dependencies

### Virtual Environment
- Always use virtual environments (venv, conda, or poetry)
- Include instructions for creating and activating the virtual environment
- Add virtual environment directories to .gitignore

### Dependencies Management
- Pin dependency versions for reproducibility
- Use requirements.txt for pip or pyproject.toml for poetry
- Separate development and production dependencies
- Keep dependencies up to date and document any version constraints

### Testing and CI/CD
- Set up GitHub Actions for continuous integration
- Include pytest for unit testing
- Add code coverage reporting
- Configure pre-commit hooks for code quality checks

### Code Quality
- Use black for code formatting
- Use flake8 or ruff for linting
- Use mypy for type checking
- Include a .editorconfig file for consistent formatting

### Documentation
- Add docstrings to all public functions and classes
- Include type hints for function parameters and return values
- Generate documentation with Sphinx or mkdocs
- Keep README.md updated with latest setup instructions