Skip to content

Conversation

@juliolmuller
Copy link
Collaborator

@juliolmuller juliolmuller commented Dec 28, 2025

Summary by CodeRabbit

  • Documentation

    • Updated package documentation with revised references and example code across README and contributing guidelines.
  • Chores

    • Updated package metadata and configuration files.
    • Project status changed from Inactive to Production/Stable.
    • Removed internal deprecation notices.

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

@juliolmuller juliolmuller requested a review from a team as a code owner December 28, 2025 15:19
@juliolmuller juliolmuller added the enhancement New feature or request label Dec 28, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 28, 2025

📝 Walkthrough

Walkthrough

This PR renames the CNPJ package from cnpj-cd to cnpj-dv across configuration files, documentation, package metadata, and source code. A deprecation warning is removed from the module's __init__.py, and all associated imports and references are updated accordingly.

Changes

Cohort / File(s) Summary
Configuration & Metadata
.pre-commit-config.yaml, packages/cnpj-dv/pyproject.toml, packages/cnpj-dv/run
Updated scopes and package name from cnpj-cd to cnpj-dv; development status classifier changed from Inactive to Production/Stable; version attribute path updated in setuptools config.
Documentation
CONTRIBUTING.md, packages/cnpj-dv/README.md, packages/cnpj-dv/CHANGELOG.md
Updated all references, badges, installation commands, imports examples, and links to reflect package name change from cnpj-cd to cnpj-dv.
Source Code
packages/cnpj-dv/src/cnpj_dv/__init__.py, packages/cnpj-dv/src/cnpj_dv/exceptions.py
Removed deprecation warning from __init__.py; updated docstring in exceptions.py to reference cnpj-dv instead of cnpj-cd.
Tests
packages/cnpj-dv/tests/cnpj_check_digits_test.py
Updated import statements to use cnpj_dv module instead of cnpj_cd.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • #43: Deprecates the old cnpj-cd package and adds metadata changes directing users to cnpj-dv—the complementary side of this rename effort.

Suggested labels

enhancement

Poem

🐰 From cd to dv, a name doth change,
No longer dormant, but stable and strange,
The warnings retreat, the docs align true,
A rebranded package, all fresh and anew!

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 summarizes the primary change: renaming the package from cnpj-cd to cnpj-dv, which is reflected consistently 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 docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/cnpj-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 3abbb91 and 1dff907.

📒 Files selected for processing (13)
  • .pre-commit-config.yaml
  • CONTRIBUTING.md
  • packages/cnpj-dv/CHANGELOG.md
  • packages/cnpj-dv/LICENSE
  • packages/cnpj-dv/README.md
  • packages/cnpj-dv/pyproject.toml
  • packages/cnpj-dv/run
  • packages/cnpj-dv/src/cnpj_dv/__init__.py
  • packages/cnpj-dv/src/cnpj_dv/cnpj_check_digits.py
  • packages/cnpj-dv/src/cnpj_dv/exceptions.py
  • packages/cnpj-dv/tests/__init__.py
  • packages/cnpj-dv/tests/cnpj_check_digits_test.py
  • packages/cnpj-dv/tests/conftest.py
💤 Files with no reviewable changes (1)
  • packages/cnpj-dv/src/cnpj_dv/init.py
🔇 Additional comments (15)
packages/cnpj-dv/src/cnpj_dv/exceptions.py (1)

1-2: LGTM!

The docstring correctly reflects the renamed package.

packages/cnpj-dv/run (1)

22-22: LGTM!

The PACKAGE_NAME constant correctly reflects the renamed package.

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

1-1: LGTM!

The changelog header correctly reflects the renamed package.

packages/cnpj-dv/tests/cnpj_check_digits_test.py (1)

1-2: LGTM!

The import correctly references the renamed cnpj_dv module.

.pre-commit-config.yaml (1)

58-58: LGTM!

The scope correctly reflects the renamed package for conventional commit validation.

CONTRIBUTING.md (2)

107-107: LGTM!

The project structure documentation correctly reflects the renamed package directory.


210-210: LGTM!

The valid scopes list correctly includes cnpj-dv for conventional commit messages.

packages/cnpj-dv/README.md (5)

1-5: LGTM!

The cover image and PyPI badges correctly reference the renamed cnpj-dv package.


21-21: LGTM!

The installation command correctly references cnpj-dv.


27-27: LGTM!

The import example correctly uses cnpj_dv (Python module naming convention with underscore).


123-123: LGTM!

All code examples consistently import from the renamed cnpj_dv module.

Also applies to: 154-154, 167-167, 180-180


278-278: LGTM!

The changelog link correctly points to the renamed package directory.

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

2-2: LGTM!

The package name correctly reflects the rename to cnpj-dv.


20-20: LGTM!

The development status change from "Inactive" to "Production/Stable" is appropriate for an actively maintained package being released.


56-56: LGTM!

The version attribute path correctly references the renamed cnpj_dv module.


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

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

@juliolmuller juliolmuller merged commit 2fe8218 into main Dec 28, 2025
12 checks passed
@juliolmuller juliolmuller deleted the feat/cnpj-dv branch December 28, 2025 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants