Skip to content
Prompt

pyDeprecate — Copilot Instructions

by Borda

AI Summary

pyDeprecate is a lightweight Python library (Python 3.9+) for decorator-based deprecation of functions, methods, and classes with automatic call forwarding. Zero runtime dependencies by design. Tests use a three-layer separation: 1. Targets () — new implementations

Install

Copy this and paste it into Claude Code, Cursor, or any AI assistant:

I want to add the "pyDeprecate — Copilot Instructions" prompt rules to my project.
Repository: https://github.com/Borda/pyDeprecate

Please read the repo to find the rules/prompt file, then:
1. Download it to the correct location (.cursorrules, .windsurfrules, .github/prompts/, or project root — based on the file type)
2. If there's an existing rules file, merge the new rules in rather than overwriting
3. Confirm what was added

Description

Smoothly deprecate and redirect Python functions/classes with smart warnings and auto-routing—keep your codebase clean while maintaining backward compatibility

Project Overview

pyDeprecate is a lightweight Python library (Python 3.9+) for decorator-based deprecation of functions, methods, and classes with automatic call forwarding. Zero runtime dependencies by design. Tech stack: Python, pytest, setuptools, pre-commit, GitHub Actions

Test Coverage Requirements

All new features and bug fixes must include tests for: • Happy path — correct behavior with valid inputs • Failure path — appropriate errors raised • Edge cases — None, empty inputs, circular chains, boundary conditions See CONTRIBUTING.md: Test Requirements

Copilot Instructions for pyDeprecate

> [!TIP] > For coding standards and contribution workflow, see CONTRIBUTING.md. For agent behavioral rules, see AGENTS.md. This file provides Copilot-specific guidance for understanding and working with the codebase.

⚠️ Important: Configuration Files Are Source of Truth

> [!WARNING] > If this documentation contradicts actual configuration files, the config files have higher authority. Trust pyproject.toml, .pre-commit-config.yaml, and other config files over documentation. When you detect a mismatch, suggest updating this documentation to match the actual configuration. Configuration files (source of truth): • pyproject.toml — project config, tool settings (ruff, mypy, pytest) • .pre-commit-config.yaml — pre-commit hooks • setup.py — package metadata and dependencies • .github/workflows/*.yml — CI/CD pipeline

Discussion

0/2000
Loading comments...

Health Signals

MaintenanceCommitted 4d ago
Active
AdoptionUnder 100 stars
55 ★ · Niche
DocsREADME + description
Well-documented

GitHub Signals

Stars55
Forks6
Issues6
Updated4d ago
View on GitHub
Apache-2.0 License

My Fox Den

Community Rating

Sign in to rate this booster

Works With

Any AI assistant that accepts custom rules or system prompts

Claude
ChatGPT
Cursor
Windsurf
Copilot
+ more