Migration Checklist
Use this checklist to track migration progress. Copy into your working notes and check off items as completed.
Dependencies
- Update
honchopackage to v2.0.0 - Remove any
honcho-coreimports
Async Architecture Changes
- Remove
AsyncHonchoimports → useHonchowith.aioaccessor - Remove
AsyncPeerimports → usePeerwith.aioaccessor - Remove
AsyncSessionimports → useSessionwith.aioaccessor - Update all async client usage to use
.aioaccessor pattern - Update type hints:
AsyncPeer→Peer,AsyncSession→Session
Terminology: Observations → Conclusions
- Replace
Observationimport withConclusion - Replace
ObservationScopeimport withConclusionScope - Replace
AsyncObservationScopeimport withConclusionScopeAio - Replace
.observationsproperty with.conclusions - Replace
.observations_of()method with.conclusions_of() - Replace
.get_representation()with.representation()
Representation Changes
- Remove
Representationimport (now returnsstr) - Remove
ExplicitObservationimport - Remove
DeductiveObservationimport - Replace
working_rep()withrepresentation() - Update type hints from
Representationtostr - Remove
.explicitproperty access - Remove
.deductiveproperty access - Replace
.is_empty()checks withnot rep - Remove
.merge_representation()calls - Remove
.diff_representation()calls - Remove
.str_no_timestamps()calls - Remove
.format_as_markdown()calls
Configuration Changes
- Replace all
config=parameters withconfiguration= - Replace
.get_config()with.get_configuration() - Replace
.set_config()with.set_configuration() - Rename
.get_peer_config()→.get_peer_configuration() - Rename
.set_peer_config()→.set_peer_configuration() - Import typed config classes from
honcho.api_typesif needed:-
PeerConfig -
SessionConfiguration -
WorkspaceConfiguration
-
Method Renames
Peer Methods
-
peer.working_rep()→peer.representation() -
peer.get_context()→peer.context() -
peer.get_sessions()→peer.sessions() -
peer.chat(stream=True)→peer.chat_stream()
Session Methods
-
session.get_context()→session.context() -
session.get_summaries()→session.summaries() -
session.get_messages()→session.messages() -
session.get_peers()→session.peers() -
session.get_peer_config()→session.get_peer_configuration() -
session.set_peer_config()→session.set_peer_configuration() -
session.working_rep()→session.representation() -
session.get_deriver_status()→session.queue_status() - Remove
session.poll_deriver_status()calls
Client Methods
-
client.get_peers()→client.peers() -
client.get_sessions()→client.sessions() -
client.get_workspaces()→client.workspaces() -
client.get_deriver_status()→client.queue_status() - Remove
client.poll_deriver_status()calls - Move
client.update_message()→session.update_message()
Parameter Renames
-
include_most_derived=→include_most_frequent= -
max_observations=→max_conclusions= -
last_user_message=→search_query=
Return Type Changes
- Handle
card()returninglist[str] | Noneinstead ofstr - Handle
.list()on conclusions returningSyncPageinstead oflist
Removed Features
- Remove any usage of
client.coreproperty - Remove usage of
"demo"environment (only"local"and"production"remain) - Implement custom polling if you were using
poll_deriver_status()
Type Import Updates
- Replace
PeerContextimport withPeerContextResponsefromhoncho.api_types - Replace
DeriverStatusimport withQueueStatusResponsefromhoncho.api_types - Replace
MessageCreateParamwithMessageCreateParams(plural) - Move
SessionPeerConfigimport fromhoncho.sessiontohoncho.api_types
Exception Handling (Optional)
- Update exception handling to use new exception types if needed:
HonchoError,APIError,BadRequestError,AuthenticationErrorPermissionDeniedError,NotFoundError,ConflictErrorUnprocessableEntityError,RateLimitError,ServerErrorTimeoutError,ConnectionError
Final Verification
- Run type checker (mypy/pyright) with no errors
- Run tests
- Verify async operations work with
.aioaccessor - Verify streaming functionality works with
chat_stream() - Verify configuration changes take effect