Skip to content

Conversation

@MiniCodeMonkey
Copy link
Member

Summary

This PR renames the main client class from GeocodioClient to Geocodio for improved simplicity and consistency with other Geocodio SDKs.

Changes

  • Renamed GeocodioClient class to Geocodio in src/geocodio/client.py
  • Updated package exports in src/geocodio/__init__.py
  • Updated all test files to use the new class name
  • Updated README documentation and code examples
  • Updated smoke test scripts

Breaking Change

⚠️ This is a breaking change - Users will need to update their imports:

# Old
from geocodio import GeocodioClient
client = GeocodioClient(api_key="...")

# New
from geocodio import Geocodio
client = Geocodio(api_key="...")

Test Plan

  • Unit tests pass (53 tests passing)
  • Import verification successful
  • Test coverage maintained at 87%

Test Suites Covered:

  • test_client.py - Client initialization and configuration tests
  • test_geocoding.py - Geocoding functionality tests
  • test_geocode.py - Geocode operation tests
  • test_reverse.py - Reverse geocoding tests
  • test_models.py - Data model tests
  • test_exceptions.py - Exception handling tests
  • test_errors.py - Error mapping tests

BREAKING CHANGE: The main client class has been renamed from GeocodioClient to Geocodio for simplicity and consistency with other SDKs.

Migration guide:
- Change imports from `from geocodio import GeocodioClient` to `from geocodio import Geocodio`
- Update instantiation from `client = GeocodioClient(...)` to `client = Geocodio(...)`
Update all test files and smoke tests to import and use the new Geocodio class name instead of GeocodioClient.
Update all code examples and documentation in README to reflect the renamed class.
@MiniCodeMonkey MiniCodeMonkey changed the title refactor\!: Rename GeocodioClient to Geocodio refactor!: Rename GeocodioClient to Geocodio Aug 8, 2025
@MiniCodeMonkey MiniCodeMonkey merged commit e2a981f into main Aug 8, 2025
1 check passed
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.

2 participants