---
id: ifcfg
version: "0.24"
license: BSD
license_treatment: permissive
maintenance: dormant
---

# ifcfg — Python ifconfig wrapper for Unix/Linux/MacOSX + ipconfig for Windows

License: permissive · Maintenance: dormant · Downloads: 151.1K/mo

## What it is and what it does

Ifcfg is a lightweight cross-platform wrapper around system network configuration commands. It parses the output of ifconfig (Unix/Linux/macOS), ipconfig (Windows), or the ip command (newer Unix systems) and returns structured data about network interfaces—IP addresses (both IPv4 and IPv6), netmasks, MAC addresses, broadcast addresses, MTU, and interface flags. The library handles multiple addresses per interface and provides a simple dictionary-based API to query all interfaces or retrieve the default interface.

The package is useful when you need to programmatically discover local network configuration without external dependencies. It has no runtime dependencies and installs as a pure Python wheel. The main trade-off is that it relies on system commands being present and their output format remaining stable; Windows support is documented as English-only, and the project has been dormant since 2023-04-19.

Use it for:

- Retrieve the local IP address of the default network interface for service discovery or logging.
- Enumerate all network interfaces and their addresses to configure multi-homed applications.
- Detect MAC addresses for hardware identification or network diagnostics.
- Extract netmask and broadcast information for subnet calculations in network tools.
- Build cross-platform network utilities that need to work on Windows, Linux, and macOS without external libraries.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Ifcfg parses network interface configuration from system commands (ifconfig, ipconfig, or ip) across Windows and Unix platforms, extracting IP addresses, netmasks, MAC addresses, and other interface metadata.

Yes, if you need simple cross-platform network interface discovery and can tolerate dormancy. The package is stable, dependency-free, and widely used. Install it for straightforward IP/interface queries; avoid it if you need active maintenance, support for non-English Windows, or cutting-edge Python version guarantees. Check that system commands (ifconfig/ipconfig/ip) are available on your target platforms.

## Install

pip install ifcfg
uv add ifcfg
poetry add ifcfg

## Installing ifcfg

Before you install: Installation is straightforward with no runtime dependencies. The package is dormant (last release 2023-04-19, no commits for 1213 days), but marked Production/Stable and has been maintained across multiple Python versions including 3.10 and 3.11.

License in practice: BSD License (permissive) allows commercial and private use with minimal restrictions—include a copy of the license and attribute the original authors.

Quickstart:

import ifcfg

for name, interface in ifcfg.interfaces().items():
    print(f"{name}: {interface['inet']}")

default = ifcfg.default_interface()

Requires ifconfig, ipconfig, or ip command available on the system; Windows support is English-only.

Verify before relying:

- Whether non-English Windows systems are now supported (release notes indicate known issues with localization).
- Current test coverage and whether the package works reliably on modern Python 3.10+ given the long dormancy.
- Actual usage scale and reliability in production environments.

## Package facts

- License: BSD (permissive)
- Python support: unspecified
- Install friction: low
- Maintenance: dormant
- Downloads: 151.1K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

network interface discovery, parse ifconfig output, get local ip address, network interface information, cross-platform network config, system network interfaces, interface metadata extraction, network-discovery, cross-platform, system-utilities

[View on SkillFed](https://skillfed.io/packages/ifcfg) · [View on PyPI](https://pypi.org/project/ifcfg/)