Skip to main content

A pure python implementation of multicast DNS service discovery

Project description

python-zeroconf

https://github.com/python-zeroconf/python-zeroconf/workflows/CI/badge.svg https://img.shields.io/pypi/v/zeroconf.svg https://codecov.io/gh/python-zeroconf/python-zeroconf/branch/master/graph/badge.svg

Documentation.

This is fork of pyzeroconf, Multicast DNS Service Discovery for Python, originally by Paul Scott-Murphy (https://github.com/paulsm/pyzeroconf), modified by William McBrine (https://github.com/wmcbrine/pyzeroconf).

The original William McBrine’s fork note:

This fork is used in all of my TiVo-related projects: HME for Python
(and therefore HME/VLC), Network Remote, Remote Proxy, and pyTivo.
Before this, I was tracking the changes for zeroconf.py in three
separate repos. I figured I should have an authoritative source.

Although I make changes based on my experience with TiVos, I expect that
they're generally applicable. This version also includes patches found
on the now-defunct (?) Launchpad repo of pyzeroconf, and elsewhere
around the net -- not always well-documented, sorry.

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.8+

  • PyPy3.8 7.3+

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?

The easiest way to install python-zeroconf is using pip:

pip install zeroconf

How do I use it?

Here’s an example of browsing for a service:

from zeroconf import ServiceBrowser, ServiceListener, Zeroconf


class MyListener(ServiceListener):

    def update_service(self, zc: Zeroconf, type_: str, name: str) -> None:
        print(f"Service {name} updated")

    def remove_service(self, zc: Zeroconf, type_: str, name: str) -> None:
        print(f"Service {name} removed")

    def add_service(self, zc: Zeroconf, type_: str, name: str) -> None:
        info = zc.get_service_info(type_, name)
        print(f"Service {name} added, service info: {info}")


zeroconf = Zeroconf()
listener = MyListener()
browser = ServiceBrowser(zeroconf, "_http._tcp.local.", listener)
try:
    input("Press enter to exit...\n\n")
finally:
    zeroconf.close()

If you don’t know the name of the service you need to browse for, try:

from zeroconf import ZeroconfServiceTypes
print('\n'.join(ZeroconfServiceTypes.find()))

See examples directory for more.

Changelog

Changelog

License

LGPL, see COPYING file for details.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zeroconf-0.136.1.tar.gz (238.7 kB view details)

Uploaded Source

Built Distribution

zeroconf-0.136.1-cp312-cp312-manylinux_2_36_x86_64.whl (11.2 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.36+ x86-64

File details

Details for the file zeroconf-0.136.1.tar.gz.

File metadata

  • Download URL: zeroconf-0.136.1.tar.gz
  • Upload date:
  • Size: 238.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for zeroconf-0.136.1.tar.gz
Algorithm Hash digest
SHA256 2a2fe7aa94f95cb27bdef1fb6c4022c1907def45c688f70133b416191aaf1b4d
MD5 045178296991dc5f68b1497927b28475
BLAKE2b-256 2f2f8115d1b5caa950b2fd43bc5a2bcfc2d687d8535c2c701d1a438b41917971

See more details on using hashes here.

Provenance

The following attestation bundles were made for zeroconf-0.136.1.tar.gz:

Publisher: ci.yml on python-zeroconf/python-zeroconf

Attestations:

File details

Details for the file zeroconf-0.136.1-cp312-cp312-manylinux_2_36_x86_64.whl.

File metadata

File hashes

Hashes for zeroconf-0.136.1-cp312-cp312-manylinux_2_36_x86_64.whl
Algorithm Hash digest
SHA256 e37724fd43a6bdf584cddbb1cfa514011282c8fbf81ed5297814eca67495269b
MD5 6eaed117625a44692dbb49685dd0eb89
BLAKE2b-256 68eb3570a44952d34887de713bc735ad44fe98ceb8d4a5c8a208f2fb7987f9e9

See more details on using hashes here.

Provenance

The following attestation bundles were made for zeroconf-0.136.1-cp312-cp312-manylinux_2_36_x86_64.whl:

Publisher: ci.yml on python-zeroconf/python-zeroconf

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page