Restructure modules and class names

frequenz-floss / frequenz-client-base-python

Base gRPC client

https://frequenz-floss.github.io/frequenz-client-base-python/

MIT License

0 stars 3 forks source link

Restructure modules and class names #25

Closed llucax closed 8 months ago

llucax commented 8 months ago

This PR do some minor cleanups and some major project structuring to use more consistent and shorter modules and class names.

frequenz.client.base.grpc_streaming_helper was renamed to frequenz.client.base.streaming.
- The GrpcStreamingHelper class was renamed to GrpcStreamBroadcaster.
  - The constructor argument retry_spec was renamed to retry_strategy.
frequenz.client.base.retry_strategy was renamed to frequenz.client.base.retry.
- The RetryStrategy class was renamed to Strategy.

llucax commented 8 months ago

I'm planning to improve the docs too, but I will wait until this is merged because I can imagine there could be some push back. BTW, I really think we should eventually rename this project frenquenz-grpc or frequenz-grpcutil or something like that, this is not really a base class for clients but just utilities to deal with gRPC/protobuf.

llucax commented 8 months ago

I will update and improve the docs in a followup PR, and then do the v0.2.0 release.

llucax commented 8 months ago

Enabled auto-merge.

shsms commented 8 months ago

do you want to update the commit message also? https://github.com/frequenz-floss/frequenz-client-base-python/pull/25/commits/edab315116c3e0ed9ceb46f876ac6b664abd6163

llucax commented 8 months ago

Good catch, done now!

shsms commented 8 months ago

I updated the PR description also with the new name, and removed and re-enabled auto-merge, so that it uses the updated merge commit message.