This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

A simple Python interface to Zeroconf service discovery and registration. Supports python >= 2.7 <= 3.5


### Requirements

The zeroconf module assumes that the [avahi]( command-line tools avahi-browse and avahi-publish are available. On Ubuntu for example, they may me installed with:

$ sudo apt-get install avahi-utils

The module also depend on [Andrew Moffat’s subprocess wrapper][sh]. Install it with

$ pip install sh

Read more about package install methods on Install section.

If you install the package using or pip it’ll be automatically handled so you normally don’t need to do this.


### Install

There are multiple methods for installing a python package. First, download the source package, and cd to it.

Then you could directly run

$ python install

Or use pip, if you’ve got pip:

$ pip install .

Packages can be installed system-wide (with sudo):

$ sudo pip install .

On a virtualenv:

$ mkvirtualenv zeroconf $ workon zeroconf $ pip install .

And with user options:

$ python install –user


$ pip install –user .

### Running tests

Just run

$ python test

It’ll install necesary test dependences and run the tests. Note that tests on windows are not covered this way and should be run with

$ py.test –doctest-modules zeroconf/


### Zeroconf Services Discovery

Searching for all available Zeroconf services is done by

>>> from zeroconf import ZeroConf
>>> zc = ZeroConf()
>>> services =

The search can be made more specific, for example:

>>> services =, type="_workstation._tcp", domain="local")

The arguments, all optional, to the search functions are:

  • name: service name, defaults to None (interpreted as all),
  • type: service type, defaults to None (interpreted as all),
  • domain: domain name, defaults to “local”.

Search results are dictionaries:

>>> print services
{('tide [f0:7b:cb:42:ff:e0]', '_workstation._tcp', 'local'):
   {'txt': '', 'hostname': 'tide.local', 'port': '9', 'address': ''},
 ('wreck [00:26:18:4c:3f:ee]', '_workstation._tcp', 'local'):
   {'txt': '', 'hostname': 'wreck.local', 'port': '9', 'address': ''},
 ('biohazard [00:18:8b:ac:c8:45]', '_workstation._tcp', 'local'):
   {'txt': '', 'hostname': 'biohazard.local', 'port': '9', 'address': ''}}

The keys are (name, type, domain) tuples and the values are dictionaries with txt, hostname, port and address keys.

### Zeroconf Services Registration

Register a new zeroconf service in the local domain with:

>>> zc = ZeroConf()
>>> zc.register(name="ghost [08:00:27:bf:49:e1]", type="_workstation._tcp", port="9")

and when you’re done, unregister it with:

>>> zc = ZeroConf()
>>> zc.unregister(name="ghost [08:00:27:bf:49:e1]", type="_workstation._tcp", port="9")

All arguments to unregister are optional, so we could have done:

>>> zc = ZeroConf()
>>> zc.unregister(name="ghost [08:00:27:bf:49:e1]")

or even, to unregister all services published during the Python session:

>>> zc = ZeroConf()
>>> zc.unregister()


Release History

Release History


This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
zeroconf3-2.0.5.dev17.tar.gz (12.1 kB) Copy SHA256 Checksum SHA256 Source Aug 15, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting