Skip to content

Rename package from logview to logview-ag - #19

Merged
agileguy merged 2 commits into
mainfrom
rename-package-logview-ag
Feb 7, 2026
Merged

agileguy merged 2 commits into
mainfrom
rename-package-logview-ag

Conversation

@agileguy

@agileguy agileguy commented Feb 7, 2026

Copy link
Copy Markdown
Owner

Summary

  • Rename PyPI package from logview to logview-ag because the name "logview" is already taken on PyPI

Changes

  • Updated pyproject.toml with new package name
  • Updated README.md with new installation instructions
  • Updated CHANGELOG.md, DOCKER.md, PLAN.md documentation
  • Updated source code user-facing messages (adapter installation hints)
  • Updated release workflow verification message

Test Plan

  • CI passes
  • Package builds with new name
  • Release workflow publishes to PyPI as logview-ag

The name "logview" is already taken on PyPI by another project.
Renamed to logview-ag for unique namespace.

Updated:
- pyproject.toml package name
- All documentation with installation instructions
- Source code user-facing messages
- Release workflow verification message
@claude

claude Bot commented Feb 7, 2026

Copy link
Copy Markdown

Code Review: Package Rename to logview-ag

Summary

This PR successfully renames the PyPI package from logview to logview-ag due to the original name being taken on PyPI. The changes are comprehensive and consistent across all relevant files.

✅ Strengths

  1. Comprehensive Coverage: All necessary files updated consistently:

    • Package metadata (pyproject.toml)
    • Documentation (README.md, CHANGELOG.md, PLAN.md, DOCKER.md)
    • User-facing error messages (adapters, app.py, UI screens)
    • CI/CD workflows (release.yml)
  2. User Experience: Error messages correctly guide users to install with the new package name:

    • pip install logview-ag[gcp]
    • pip install logview-ag[docker]
    • pip install logview-ag[detection]
  3. Consistency: All 37 additions and 37 deletions show a clean find-and-replace operation with no inconsistencies.

  4. Backward Compatibility: The command-line entry point (logview) remains unchanged, so existing user workflows are preserved.


🔍 Issues Found

1. Missing GitHub URLs Update (CRITICAL)

The pyproject.toml still references logview in URLs, but these should likely remain as-is since the GitHub repo is still agileguy/logview. However, this should be verified:

[project.urls]
Homepage = "https://github.com/agileguy/logview"
Repository = "https://github.com/agileguy/logview"
Issues = "https://github.com/agileguy/logview/issues"
Changelog = "https://github.com/agileguy/logview/blob/main/CHANGELOG.md"

Action: Confirm this is intentional (GitHub repo name unchanged).


2. Wheel Filename Change Not Documented (HIGH)

The PR changes the expected wheel filename from logview-X.Y.Z-py3-none-any.whl to logview_ag-X.Y.Z-py3-none-any.whl (note the underscore instead of hyphen).

Location: README.md:85

Expected output: `logview_ag-X.Y.Z-py3-none-any.whl: OK`

Issue: The actual wheel filename uses an underscore (logview_ag) not a hyphen (logview-ag). This is correct per PEP 427 (wheel format), but users might be confused since the package name uses a hyphen.

Action: Consider adding a note explaining this:

Expected output: `logview_ag-X.Y.Z-py3-none-any.whl: OK`
Note: Wheel filenames use underscores while package names use hyphens (per PEP 427).

3. Missing Test Updates (MEDIUM)

The PR doesn't show any changes to test files. Tests that reference the package name might need updates.

Files to check:

  • Tests that might import logview or check package metadata
  • Integration tests that verify installation instructions

Action: Run the test suite to ensure no tests are broken by the rename:

pytest -v

4. Missing Version Bump (MEDIUM)

This is a package rename, which could be considered a MINOR version bump (0.X.0) since it changes how users install the package.

Current: No version update shown in the PR
Suggested: Bump to next MINOR version and update CHANGELOG.md with release date

Per CLAUDE.md guidelines:

Bump MINOR (0.X.0) for:

  • New features
  • New configuration options
  • Deprecations (with backwards compatibility)

A package rename falls into this category since it affects user installation workflows.

Action:

  1. Update VERSION file
  2. Move CHANGELOG.md [Unreleased] section to new version
  3. Add release date

5. Development Install Command (LOW)

README.md:63 shows the development install command:

pip install -e ".[all]"

This works because it installs from the local pyproject.toml, but it might be clearer to mention that the package will be installed as logview-ag even though the directory is named logview.


🧪 Testing Recommendations

Before merging, verify:

  1. Build the package: Ensure the wheel builds with the correct name

    python -m build
    ls dist/  # Should show logview_ag-*.whl
  2. Install locally: Test the installation works

    pip install dist/logview_ag-*.whl
    logview --version
  3. Run all tests: Ensure no broken references

    pytest
    mypy src/
    ruff check src/ tests/
  4. Verify error messages: Trigger dependency errors to ensure install hints are correct

    • Try to use GCP adapter without pip install logview-ag[gcp]
    • Try to use Docker adapter without pip install logview-ag[docker]

📋 Pre-Merge Checklist

  • CI passes (lint, type check, tests)
  • Package builds successfully with new name
  • Wheel filename is logview_ag-*.whl (underscore)
  • Command-line entry point logview still works
  • Error messages display correct install commands
  • VERSION file updated (if releasing)
  • CHANGELOG.md updated with release date (if releasing)
  • Install script tested (if it exists)

🎯 Overall Assessment

Quality: ✅ High - The rename is thorough and consistent
Completeness: ⚠️ Good - Missing version bump and test verification
Risk: ✅ Low - Simple rename with no logic changes

Recommendation: Address the version bump and verify tests before merging. The rename itself is well-executed.


📚 Additional Context

Per CLAUDE.md:

  • All CI checks must pass (pytest, mypy, ruff)
  • Version should follow semantic versioning
  • CHANGELOG.md should be updated for releases
  • ACTIONS.md should be updated after significant work

Good job on the comprehensive rename! Just needs a few polish items before merge.

@claude

claude Bot commented Feb 7, 2026

Copy link
Copy Markdown

Code Review - PR #19: Rename package from logview to logview-ag

✅ Summary

This PR correctly renames the PyPI package from logview to logview-ag to avoid conflict with an existing package on PyPI. The changes are comprehensive and consistent across the codebase.


📋 Code Quality Assessment

Excellent ✅

  1. Comprehensive scope - All references to the package name have been updated:

    • pyproject.toml (package name)
    • README.md (installation instructions, badges, uninstall)
    • Documentation (CHANGELOG.md, DOCKER.md, PLAN.md)
    • User-facing messages (error messages in adapters)
    • Test assertions
    • CI/CD workflow messages
  2. Consistency - The rename is applied uniformly across:

    • All installation commands (pip install logview[...] → pip install logview-ag[...])
    • All error messages
    • All documentation examples
    • PyPI badge URLs
  3. No breaking changes to code - The Python module name remains logview, only the PyPI distribution name changes. This is the correct approach.


🔍 Detailed Review

pyproject.toml ✅

-name = "logview"
+name = "logview-ag"

Correct. Only the distribution name changes, module structure preserved.

Documentation Updates ✅

All documentation files properly updated:

  • README.md: Installation instructions, badges, uninstall steps
  • CHANGELOG.md: Optional dependency examples
  • DOCKER.md: Docker-specific installation instructions
  • PLAN.md: Installation methods

Error Messages ✅

User-facing error messages updated in:

  • src/logview/adapters/docker.py
  • src/logview/adapters/gcp.py
  • src/logview/adapters/gke.py
  • src/logview/adapters/context_detector.py
  • src/logview/app.py
  • src/logview/ui/screens/discovery.py

All correctly updated to guide users to the new package name.

Test Assertions ✅

Test files updated to assert the new package name in error messages:

  • tests/unit/test_docker_adapter.py
  • tests/unit/test_gcp_adapter.py
  • tests/integration/test_gcp.py
  • tests/integration/test_gke.py

🐛 Issues Found: NONE

No bugs, issues, or concerns detected. The rename is implemented correctly.


⚡ Performance Considerations

No performance impact. This is purely a naming change.


🔒 Security Concerns

No security concerns. The change doesn't affect any security-related code.


🧪 Test Coverage

Test coverage maintained:

  • Existing tests updated to reflect new package name
  • No new code requires testing (pure rename)
  • Test assertions correctly validate new error messages

✨ Best Practices

Followed ✅

  1. Semantic versioning - This should be a MINOR version bump (new package name)
  2. Documentation completeness - All user-facing docs updated
  3. Consistency - No missed references
  4. Backward compatibility - Python module name unchanged

📝 Recommendations

Required Before Merge

  1. Update CLAUDE.md - The project instructions still reference logview in several places:

    • Commands show python -m logview (correct, but should note package name is different)
    • Should document that distribution name is logview-ag but module is logview
  2. Version bump - Ensure VERSION file is bumped appropriately (suggest 0.3.0 for this change)

  3. CHANGELOG.md update - Add this rename to the [Unreleased] section:

    ### Changed
    - Renamed PyPI package from `logview` to `logview-ag` (module name remains `logview`)
  4. ACTIONS.md update - Document this change in the action log

Optional Improvements

  1. README clarity - Consider adding a note explaining the package/module name difference:

    > **Note:** The PyPI package is named `logview-ag`, but you still import it as `logview` in Python.
  2. install.sh script - Check if install.sh needs updates (not visible in this PR)


🎯 Verdict

APPROVE with minor documentation updates

The code changes are excellent and comprehensive. Before merging:

  1. Update CLAUDE.md to document the package/module name difference
  2. Bump VERSION file
  3. Update CHANGELOG.md [Unreleased] section
  4. Update ACTIONS.md

Once these documentation updates are complete, this PR is ready to merge.


📊 Change Statistics

  • Files changed: 16
  • Additions: 43
  • Deletions: 43
  • Net change: 0 (perfect 1:1 replacement)

Great work on the comprehensive rename! 🎉

@agileguy
agileguy merged commit 3830187 into main Feb 7, 2026
7 checks passed
@agileguy
agileguy deleted the rename-package-logview-ag branch February 7, 2026 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant