Page MenuHomePhabricator

eventutilities-python: review and clean up in preparation for a GA release.
Closed, ResolvedPublic

Description

Before marking eventutilites-python as generally available, some code clean ups are required.

Most notably:

  • Some classes/functions in flink and manager modules. do not really belong together. Consider refactoring.
  • review all TODOs comments. Some of them have been addressed, but the TODO has not been resolved (e.g. _when retrieving the latest version of a schema, its actual version should be retrieved_).
  • the configuration format should be documented.
  • any hardcoded default value should be moved to a configuration file.
  • finalise design doc (API contracts) and publish to git.
  • warn if error string auto init generates invalid stream names.
  • remove stream_manager map in favor of just process
  • After merging this MR with print sink, remove stream_manager print

Details

TitleReferenceAuthorSource BranchDest Branch
manager: deprecate print apirepos/data-engineering/eventutilities-python!71gmodenaT336488-remove-print-apimain
Better organize eventutilties_python modulesrepos/data-engineering/eventutilities-python!69ottoT336488_ga_refactormain
stream_manager: remove map in favor of just processrepos/data-engineering/eventutilities-python!68gmodenaT336488-refactor-map-processmain
Cleanup Makefilerepos/data-engineering/eventutilities-python!65gmodenaT336488-cleanup-makefilemain
Generate HTML pages from docstringsrepos/data-engineering/eventutilities-python!62gmodenaT336488-generate-docmain
manager: error_stream_name validation.repos/data-engineering/eventutilities-python!58gmodenaT336488-error-on-invalid-stream-namemain
Customize query in GitLab

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript
gmodena renamed this task from [NEEDS GROOMING] eventutilities-python: review and clean up to eventutilities-python: review and clean up in preparation for a GA release..May 11 2023, 12:05 PM
gmodena moved this task from Backlog to Sprint 14 A on the Event-Platform board.
gmodena edited projects, added Event-Platform (Sprint 14 A); removed Event-Platform.
gmodena moved this task from In progress to Next Up on the Event-Platform (Sprint 14 A) board.
gmodena updated the task description. (Show Details)

Think we can publish pydocs as part of this task!?

Sure, seems easy enough.