wait-for-it

library2.3.0pypypi✓ verified 89d ago

A cross-platform command-line tool that waits for one or more network services (TCP or UDP) to become available before executing a command. Version 2.3.0, released in 2024, requires Python >=3.9. Stable, low release cadence.

devops http-networking

pip install wait-for-it

github ↗package ↗

INSTALL

IMPORT

SIG · WAIT-FOR-IT

wait-for-it

devopspythonv2.3.0

Install

1.6s avg

Import

236ms

Disk

17MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v2.3.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.256s · 18.7MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 1.6s · import 0.216s · 19MB

17MB installed

● package 17MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

wait_for_it

✓ from wait_for_it import wait_for_it

The package provides a CLI; the Python API is not the primary use case.

Wait for a PostgreSQL service on localhost:5432 with a 30-second timeout.

from wait_for_it import wait_for_it await wait_for_it('tcp://localhost:5432', timeout=30)

wait-for-it --version

Debug

Known issues

deprecatedPython 3.8 support dropped in v2.3.0. Users on 3.8 must pin to v2.2.0 or upgrade Python.

fix

Upgrade Python to >=3.9 or pin pip install wait-for-it==2.2.0

affects: >=2.3.0

gotchaThe Python API is asynchronous. Calling wait_for_it without await or in a non-async context will raise a RuntimeWarning or return a coroutine object.

fix

Use async/await or call asyncio.run(wait_for_it(...))

affects: all

breakingIn v2.0.0, the import path changed from wait_for_it.wait_for_it to wait_for_it.

fix

Update import to: from wait_for_it import wait_for_it

affects: >=2.0.0

Errors

Common errors & fixes

RuntimeWarning: coroutine 'wait_for_it' was never awaited

The wait_for_it function is async but called without await.

fix

Use await: await wait_for_it('tcp://...') or wrap with asyncio.run().

ModuleNotFoundError: No module named 'wait_for_it'

The package is not installed or the import path is wrong (old import style).

fix

Install via pip install wait-for-it and use from wait_for_it import wait_for_it.

ValueError: Unsupported scheme: http

The URL scheme must be tcp or udp, not http or others.

fix

Use tcp://host:port or udp://host:port.

Upgrade

Version history

2.3.0latest on PyPI · released Oct 13, 2024

Audit

Dependencies

No dependency data recorded yet.

Agent activity

16 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/hartwork/wait-for-it ↗

packagehttps://pypi.org/project/wait-for-it/ ↗