Skip to content

Comments

Updates to README.md.#3

Merged
schandrika merged 13 commits intoeclipse-volttron:developfrom
davidraker:bus_adapter_changes
Feb 13, 2026
Merged

Updates to README.md.#3
schandrika merged 13 commits intoeclipse-volttron:developfrom
davidraker:bus_adapter_changes

Conversation

@davidraker
Copy link
Contributor

@davidraker davidraker commented Oct 1, 2025

This pull request introduces improvements and bug fixes to the Protocol Proxy library, focusing on better socket handling, enhanced logging, and documentation updates. The most significant changes include improved handling of non-blocking sockets in the gevent implementation, updates to the README for clarity and visibility, and adjustments to logging to reduce verbosity and clarify debug information.

Socket Handling Improvements (Gevent):

  • Added a _non_blocking_socket context manager to handle non-blocking socket operations with timeout and retry logic, improving reliability and addressing issues with BlockingIOError in src/protocol_proxy/ipc/gevent.py.
  • Updated _receive_headers and _receive_socket to use the new context manager, improving error handling and robustness when reading headers and data from sockets. [1] [2]
  • Improved logic for accepting new client connections and handling BlockingIOError during socket accept, preventing unnecessary exceptions and failures.

Documentation and Metadata Updates:

  • Expanded and clarified the README.md with installation instructions, dependency information, and badges for Python versions, test status, and PyPI version, making the project easier to understand and use.
  • Updated the package version in pyproject.toml to 2.0.0rc2 and fixed the python_version formatting for mypy. [1] [2]

Logging and Debug Output Adjustments:

  • Reduced debug logging throughout the codebase, replacing many _log.debug statements with comments or more informative log messages to minimize log noise and clarify important events. [1] [2] [3] [4] [5] [6] [7] [8]
  • Improved warning and info log messages to include additional context, such as peer names and request IDs, especially when handling socket errors or unknown method names. [1] [2]

Bug Fixes and Minor Improvements:

  • Fixed the order of adding outbound sockets and messages in the gevent IPC implementation to ensure correct socket management.
  • Enhanced callback registration logic in the base IPC class to prevent duplicate callback registrations and provide confirmation logs.
  • Improved IPv6 socket handling in the asyncio IPC implementation by correctly extracting host and port from the socket address tuple.

Development and Internal Consistency:

  • Added internal comments and minor code tweaks to clarify process management and proxy setup routines in the manager classes. [1] [2] [3]

These changes collectively improve the reliability, usability, and maintainability of the Protocol Proxy library.This pull request updates the README.md file to provide a more comprehensive and user-friendly introduction to the Protocol Proxy library. The new README includes badges, installation instructions, an overview of the library's functionality, development guidelines, and a disclaimer notice.

Key improvements to project documentation:

  • Added project badges for Python versions, test status, and PyPI version to the top of the README for quick reference.
  • Expanded the project description to explain the purpose, architecture, and plugin support of the Protocol Proxy library.
  • Included clear installation instructions using pip, and guidance for users of protocol plugins.
  • Added a section with development and contribution guidelines, linking to the main VOLTTRON contributing documentation.
  • Appended a detailed disclaimer notice regarding government sponsorship and liability.

@schandrika schandrika merged commit 4c31a05 into eclipse-volttron:develop Feb 13, 2026
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.

3 participants