v0.11.0

[github-actions[bot]]

Frequenz Channels Release Notes

Summary

The project has a new home!

https://frequenz-floss.github.io/frequenz-channels-python/

For now the documentation is pretty scarce but we will be improving it with
time.

Upgrading (breaking changes)

• You need to make sure to use timezone-aware datetime objects when using
  the timestamp returned by Timer, Otherwise you will get an exception.

• Channels methods get_receiver() and get_sender() have been renamed to
  new_receiver() and new_sender() respectively. This is to make it more
  clear that new objects are being created.

• The public API surface has been reduced considerably to make it more clear
  where to import symbols. You should update your imports. The new symbol
  locations are:

  • frequenz.channels.Anycast
  • frequenz.channels.Broadcast
  • frequenz.channels.Anycast
  • frequenz.channels.Bidirectional
  • frequenz.channels.Broadcast
  • frequenz.channels.Peekable
  • frequenz.channels.Receiver
  • frequenz.channels.Sender
  • frequenz.channels.util.Merge
  • frequenz.channels.util.MergeNamed
  • frequenz.channels.util.FileWatcher
  • frequenz.channels.util.Select
  • frequenz.channels.util.Timer

• The class BufferedReceiver was removed because the interface was really
  intended for channel implementations. Users are not supposed to enqueue
  messages to receiver but just receive from them. If you used it you can
  implement it yourself.

• The class BidirectionalHandle was moved to Bidirectional.Handle.

• The class EventType was moved to FileWatcher.EventType.

New Features

• Python 3.11 is now supported!

Bug Fixes

• Broadcast receivers now get cleaned up once they go out of scope.

• Timer now returns timezone-aware datetime objects using UTC as
  timezone.

What's Changed

• Fix project URLs by @leandro-lucarella-frequenz in Fix project URLs #18
• ci: Test also Python 3.11 pre-releases by @leandro-lucarella-frequenz in ci: Test also Python 3.11 pre-releases #19
• Remove version:xxx and add part:select and part:receivers labels by @leandro-lucarella-frequenz in Remove version:xxx and add part:select and part:receivers labels #28
• Use MkDocs to build the documentation by @leandro-lucarella-frequenz in Use MkDocs to build the documentation #25
• ci: Add contents permission to publish-docs by @leandro-lucarella-frequenz in ci: Add contents permission to publish-docs #33
• ci: Update aliases when deploying with mike by @leandro-lucarella-frequenz in ci: Update aliases when deploying with mike #38
• Add PyPI and Docs badges to README by @shsms in Add PyPI and Docs badges to README #34
• ci: Use the final Python 3.11 version by @leandro-lucarella-frequenz in ci: Use the final Python 3.11 version #39
• docs: Replace the Home with the README by @leandro-lucarella-frequenz in docs: Replace the Home with the README #40
• Fix CONTRIBUTING headings by @leandro-lucarella-frequenz in Fix CONTRIBUTING headings #41
• Use "aware" datetimes by @leandro-lucarella-frequenz in Use "aware" datetimes #48
• Ensure deleted receivers get cleaned up by @shsms in Ensure deleted receivers get cleaned up #45
• Avoid dropping of messages after breaking from Select blocks by @shsms in Avoid dropping of messages after breaking from Select blocks #42
• Rename get_{sender,receiver} to new_{sender,receiver} by @leandro-lucarella-frequenz in Rename get_{sender,receiver} to new_{sender,receiver} #49
• Clean up public API by @leandro-lucarella-frequenz in Clean up public API #55
• FileWatcher: Don't type-check changes by @leandro-lucarella-frequenz in FileWatcher: Don't type-check changes #56
• Add Python 3.11 support to RELEASE_NOTES by @leandro-lucarella-frequenz in Add Python 3.11 support to RELEASE_NOTES #57

Full Changelog: v0.10.0...v0.11.0

---

This discussion was created from the release v0.11.0.