Skip to main content

A CLI utility for blocking until a service is listening

Project description

I needed a way to block my app from starting until the database service was running and accepting connections. This was particularly a problem when using Docker and docker-compose. You can run this utility as part of a or script and it will block for 15 seconds (configurable) until it can connect to the hostname and port as specified in your connection URL (gleaned from DATABASE_URL environment variable by default).


$ pip install urlwait


$ urlwait --help


    $ urlwait [SERVICE URL] [TIMEOUT]

    SERVICE URL is a connection url, e.g. a typical value for $DATABASE_URL. TIMEOUT is
    a number of seconds to try to connect to the host and port specified in the SERVICE
    URL. These values may also be specified in environment variables, but command line
    args take precedence:

        URLWAIT_VARNAME: the env var name containing the URL to check. Default DATABASE_URL.
        URLWAIT_TIMEOUT: the number of seconds to wait. Default 15.

    Returns a 0 status if the connection completed successfully before the timeout, or 1 if not.
    It is designed for use with Docker or other dev or testing environments where the connected
    services and the app are started simultaneously, but one should wait for the other.


    The following are equivalent:

    $ urlwait redis://localhost:6379/0 20
    $ urlwait $CACHE_URL 20

The module is also usable in your python code:

import os

from urlwait import wait_for_url

if wait_for_url(os.getenv('REDIS_URL')):
    # do things with the service
    # service likely did not start

If you don’t have the service URL but do have the host and port, you can use the wait_for_service(host, port, timeout) function instead.

Python Support

Since version 1.0 urlwait is Python 3 only. If you need Python 2.7 support you can use a pre 1.0 release.


  • 1.0 - 2020-02-28 * Close the socket to keep Python from complaining. Thanks @callahad! * Update tests to only test on Python 3.6+ * Drop support for Python 2.x

  • 0.4 - 2017-03-02 - Always return true if protocol is sqlite

Project details

Download files

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

Source Distribution

urlwait-1.0.tar.gz (5.1 kB view hashes)

Uploaded Source

Built Distribution

urlwait-1.0-py2.py3-none-any.whl (5.2 kB view hashes)

Uploaded Python 2 Python 3

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