GitHub - python-zeroconf/python-zeroconf: A pure python implementation of multicast DNS service discovery
.
This project is a fork of pyzeroconf, originally by Paul Scott-Murphy (
https://github.com/paulsm/pyzeroconf
), modified by William McBrine (
https://github.com/wmcbrine/pyzeroconf
).
Compatible with:
Bonjour
Avahi
Compared to some other Zeroconf/Bonjour/Avahi Python packages, python-zeroconf:
isn't tied to Bonjour or Avahi
doesn't use D-Bus
doesn't force you to use particular event loop or Twisted (asyncio is used under the hood but not required)
is pip-installable
has PyPI distribution
has an optional cython extension for performance (pure python is supported as well)
Python compatibility
CPython 3.10+
PyPy 3.10+
Versioning
This project uses semantic versioning.
Status
This project is actively maintained.
Traffic Reduction
Before version 0.32, most traffic reduction techniques described in
https://datatracker.ietf.org/doc/html/rfc6762#section-7
where not implemented which could lead to excessive network traffic. It is highly recommended that version 0.32 or later is used if this is a concern.
IPv6 support
IPv6 support is relatively new and currently limited, specifically:
InterfaceChoice.All is an alias for InterfaceChoice.Default on non-POSIX systems.
Dual-stack IPv6 sockets are used, which may not be supported everywhere (some BSD variants do not have them).
Listening on localhost (::1) does not work. Help with understanding why is appreciated.
How to get python-zeroconf?
PyPI page
https://pypi.org/project/zeroconf/
GitHub project
https://github.com/python-zeroconf/python-zeroconf
The easiest way to install python-zeroconf is using pip:
pip install zeroconf How do I use it?
Here's how to discover services:
fromzeroconfimportServiceBrowser, ServiceListener, ZeroconfclassEventLogger(ServiceListener): defadd_service(self, zc: Zeroconf, type_: str, name: str) ->None: info=zc.get_service_info(type_, name) print(f"discovered {name}: {info}") defremove_service(self, zc: Zeroconf, type_: str, name: str) ->None: print(f"lost {name}") defupdate_service(self, zc: Zeroconf, type_: str, name: str) ->None: print(f"refreshed {name}") withZeroconf() aszc: ServiceBrowser(zc, "_http._tcp.local.", EventLogger()) input("browsing, press enter to stop\n")Note
Discovery and service registration use all available network interfaces by default. If you want to customize that you need to specify interfaces argument when constructing Zeroconf object (see the code for details).
To see which service types are present on the network, try:
fromzeroconfimportZeroconfServiceTypesprint('\n'.join(ZeroconfServiceTypes.find()))See examples directory for more.
Changelog
License
GNU Lesser General Public License v2.1 or later (LGPL-2.1-or-later).
The full text of LGPL 2.1 is included in the
file. You may, at your option, use this library under the terms of any later version of the LGPL published by the Free Software Foundation. The canonical SPDX identifier for this project is LGPL-2.1-or-later, as declared in pyproject.toml.