Deprecating cnpj-cd and cpf-cd packages

[juliolmuller]

Summary by CodeRabbit

• Documentation

  • Updated README files with migration guidance to the renamed packages (cnpj-dv and cpf-dv), including uninstall/install commands, corrected import examples, and links to the new repositories.

• Deprecation

  • Marked cnpj-cd and cpf-cd as inactive in project metadata.
  • Added runtime deprecation notices that inform users to migrate to the renamed packages.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Deprecates two packages (cnpj-cd, cpf-cd) by adding README deprecation notices, changing pyproject classifiers to "Inactive", and emitting runtime DeprecationWarning on module import; users are directed to the renamed packages (cnpj-dv, cpf-dv) with updated install/import guidance.

Changes

Cohort / File(s)	Summary
CNPJ Package Deprecation packages/cnpj-cd/README.md, packages/cnpj-cd/pyproject.toml, packages/cnpj-cd/src/cnpj_cd/__init__.py	README gains deprecation/migration text and link to cnpj-dv; pyproject classifier set to "Development Status :: 7 - Inactive"; module-level DeprecationWarning emitted on import (stacklevel=2).
CPF Package Deprecation packages/cpf-cd/README.md, packages/cpf-cd/pyproject.toml, packages/cpf-cd/src/cpf_cd/__init__.py	README gains deprecation/migration text and link to cpf-dv; pyproject classifier set to "Development Status :: 7 - Inactive"; module-level DeprecationWarning emitted on import (stacklevel=2).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped in to whisper, a soft little nudge,
Two packages rest — time for a trudge.
cnpj and cpf pass the baton with cheer,
Toward dv they go, the path bright and clear.
Farewell, old modules — new imports appear. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and accurately summarizes the main change: deprecating two packages (cnpj-cd and cpf-cd), which is reflected across all modified files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch deprecate/cd-packages

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e3042c2 and 5483d85.

📒 Files selected for processing (2)

• packages/cnpj-cd/README.md
• packages/cpf-cd/README.md

🚧 Files skipped from review as they are similar to previous changes (2)

• packages/cpf-cd/README.md
• packages/cnpj-cd/README.md

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ee4569e and e3042c2.

📒 Files selected for processing (6)

• packages/cnpj-cd/README.md
• packages/cnpj-cd/pyproject.toml
• packages/cnpj-cd/src/cnpj_cd/__init__.py
• packages/cpf-cd/README.md
• packages/cpf-cd/pyproject.toml
• packages/cpf-cd/src/cpf_cd/__init__.py

🔇 Additional comments (6)

packages/cpf-cd/pyproject.toml (1)

20-20: LGTM! Appropriate classifier for deprecated package.

The "7 - Inactive" development status correctly signals to PyPI users that this package is no longer maintained, aligning with the deprecation strategy.

packages/cnpj-cd/pyproject.toml (1)

20-20: LGTM! Appropriate classifier for deprecated package.

The "7 - Inactive" development status correctly signals to PyPI users that this package is no longer maintained.

packages/cnpj-cd/src/cnpj_cd/__init__.py (2)

1-2: LGTM! Proper import for deprecation warning.

The warnings module import is correctly added to support the deprecation notice.

---

21-25: Deprecation warning implemented correctly.

The runtime warning uses DeprecationWarning with stacklevel=2, which is the standard approach for library deprecations. Note that DeprecationWarning is hidden by default in Python production environments (visible during testing), which is by design to avoid cluttering end-user logs. Since your README includes a prominent deprecation notice, users will be informed through documentation.

If you want the warning to be visible in all contexts, consider using FutureWarning instead, which is shown by default.

Would you like to verify that DeprecationWarning (hidden by default) is the intended choice, or would FutureWarning (always visible) better serve your deprecation strategy?

packages/cpf-cd/src/cpf_cd/__init__.py (2)

1-2: LGTM! Proper import for deprecation warning.

The warnings module import is correctly added to support the deprecation notice.

---

23-27: Deprecation warning implemented correctly.

The runtime warning uses DeprecationWarning with stacklevel=2, following Python's standard library deprecation practices. This warning type is hidden by default in production (visible during development/testing), which prevents log pollution for end users while alerting developers during integration.

Combined with the prominent README notice, this provides appropriate multi-layered deprecation communication.

If you prefer the warning to be always visible to all users, consider FutureWarning instead of DeprecationWarning.