Renaming package cpf-cd to cpf-dv

[juliolmuller]

Summary by CodeRabbit

Release Notes

• Documentation

  • Updated installation instructions and code examples.

• Chores

  • Updated project metadata and marked package as production-ready.
  • Removed deprecation warning triggered on module import.
  • Updated configuration files.

• Tests

  • Updated test imports to reference updated package paths.

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

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request renames the CPF package from cpf-cd to cpf-dv across the codebase. The changes include updating package metadata, configuration files, documentation, import paths, removing a module-level deprecation warning, and adjusting the development status classifier from "Inactive" to "Production/Stable."

Changes

Cohort / File(s)	Summary
Root Configuration & Documentation .pre-commit-config.yaml, CONTRIBUTING.md	Updated pre-commit hook scopes and project structure documentation to reference cpf-dv instead of cpf-cd
Package Metadata & README packages/cpf-dv/pyproject.toml, packages/cpf-dv/CHANGELOG.md, packages/cpf-dv/README.md	Updated project name metadata from cpf-cd to cpf-dv, changed development status to Production/Stable, updated version attribute source, and replaced all installation and import instructions to reference cpf-dv module names
Package Source Code packages/cpf-dv/src/cpf_dv/__init__.py, packages/cpf-dv/src/cpf_dv/exceptions.py	Removed module-level deprecation warning and its import from __init__.py; updated exception docstring to reference cpf-dv instead of cpf-cd
Package Scripts & Tests packages/cpf-dv/run, packages/cpf-dv/tests/cpf_check_digits_test.py	Updated PACKAGE_NAME constant from "cpf-cd" to "cpf-dv" in run script and corrected test import paths from cpf_cd to cpf_dv

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• Deprecating cnpj-cd and cpf-cd packages #43: Addresses the same cpf-cd → cpf-dv rename and modifies equivalent package metadata and deprecation handling in __init__.py

Poem

🐰 So long, dear cpf-cd, you served us well,
Now cpf-dv takes the bell! 🔔
Warnings fade, production gleams,
This package hops toward better dreams ✨

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 accurately and clearly summarizes the main change: renaming the cpf-cd package to cpf-dv across all files and references in the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feat/cpf-dv

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 503fd0f and ae52c4d.

📒 Files selected for processing (13)

• .pre-commit-config.yaml
• CONTRIBUTING.md
• packages/cpf-dv/CHANGELOG.md
• packages/cpf-dv/LICENSE
• packages/cpf-dv/README.md
• packages/cpf-dv/pyproject.toml
• packages/cpf-dv/run
• packages/cpf-dv/src/cpf_dv/__init__.py
• packages/cpf-dv/src/cpf_dv/cpf_check_digits.py
• packages/cpf-dv/src/cpf_dv/exceptions.py
• packages/cpf-dv/tests/__init__.py
• packages/cpf-dv/tests/conftest.py
• packages/cpf-dv/tests/cpf_check_digits_test.py

💤 Files with no reviewable changes (1)

• packages/cpf-dv/src/cpf_dv/init.py

🔇 Additional comments (14)

packages/cpf-dv/tests/cpf_check_digits_test.py (1)

2-7: Import path correctly updated to align with the package rename.

The import statement now references cpf_dv instead of cpf_cd, consistent with the package rename across the repository.

packages/cpf-dv/CHANGELOG.md (1)

1-1: Changelog header correctly updated to reflect the new package name.

.pre-commit-config.yaml (1)

58-58: Commit scope list correctly updated to include cpf-dv.

The conventional-pre-commit hook now enforces the new package scope, ensuring consistent commit messages.

packages/cpf-dv/run (1)

22-22: Package name constant correctly updated.

The PACKAGE_NAME variable now reflects the renamed package, ensuring the run script delegates commands correctly.

packages/cpf-dv/src/cpf_dv/exceptions.py (1)

1-2: Base exception docstring correctly updated to reference the new package name.

CONTRIBUTING.md (2)

117-118: Project structure documentation correctly updated to reflect the package rename.

---

210-210: Valid commit scopes list correctly updated to include cpf-dv.

This aligns with the .pre-commit-config.yaml scopes configuration.

packages/cpf-dv/pyproject.toml (3)

2-2: Package name correctly updated in project metadata.

---

20-20: Development status upgraded from Inactive to Production/Stable.

This is a significant classifier change indicating the package is now production-ready. Ensure this aligns with the project's maturity and stability guarantees.

---

56-56: Version attribute reference correctly updated to the new module namespace.

packages/cpf-dv/README.md (4)

1-8: Documentation badges and cover image correctly updated to reference the new package name.

The PyPI links will be valid once the package is published under the new name.

---

21-21: Installation command correctly updated.

---

27-27: All import statements in code examples correctly updated to use cpf_dv.

The documentation examples now consistently reference the renamed module.

Also applies to: 122-122, 153-153, 166-166, 179-179, 192-192

---

292-292: Changelog link correctly updated to point to the new package location.

---

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.}