netpulse-subnet 0.1.2

Subnetting and network discovery tool

NetPulse Subnet

High-performance, standalone Python library & CLI for IPv4 network calculations, FLSM splitting, and VLSM allocation.

---

netpulse-subnet is a standalone network administration tool extracted from the larger NetPulse discovery suite. It is built to help network engineers programmatically calculate, partition, and optimize IPv4 address spaces natively in Python or directly from the terminal.

✨ Features

• Subnet Calculator (info): Deep visibility into IP boundaries, subnet masks, wildcard masks, and bitwise binary representation.
• Fixed-Length Subnet Splitter (split): Flawlessly chunk large network blocks (FLSM) based on exact host requirements or target partition counts.
• Variable-Length Planner (vlsm): Eliminate IP wastage. Pass an array of varying host requirements and mathematically sort them into the tightest fitting CIDR blocks dynamically.
• Namespace Packaging: Fully decoupled from netpulse-core. It functions as a lightweight script with minimal dependencies (only pydantic, typer, and fastapi).
• REST API Enabled: Run the built-in FastAPI uvicorn wrapper to serve subnet calculation logic dynamically to web dashboards or automation scripts.

🚀 Quickstart

Installation

Install globally or locally via pip:

pip install netpulse-subnet

CLI Usage

# Calculate detailed subnet boundaries for an IP
netpulse-subnet info 192.168.1.50/24

# Split a class A network into equal /10 blocks
netpulse-subnet split 10.0.0.0/8 --subnets 4

# Optimize and allocate VLSM blocks from a /24 parent network
netpulse-subnet vlsm 192.168.1.0/24 --req "HR=120,Dev=50,Sales=20,Guest=10"

Python API Integration

Use our cleanly typed Pydantic models and logic natively inside your own tools:

from netpulse.subnet.services.subnet import calculate_subnet_info, allocate_vlsm

# Retrieve detailed boundary models
info = calculate_subnet_info("192.168.1.50", "24")
print(f"Broadcast IP: {info.broadcast_address}")

# Plan VLSM allocation
result = allocate_vlsm("192.168.1.0/24", [{"name": "HR", "hosts": 120}])
print(f"Allocated block: {result.allocations[0].network_cidr}")

📖 Documentation

For in-depth explanations, architectural decisions, and integration examples, dive into the documentation:

• 🗺️ Usage Guide - Deep dive into CLI and REST API examples.
• 🐍 API Reference - Documentation for the Python service layer and Pydantic models.
• 🧠 Design & Algorithms - Read about the mathematical algorithms behind our FLSM and VLSM operations.
• 🏗️ Architecture - Understand the strict separation of concerns and netpulse implicit namespace.
• 🧪 Testing - Learn how to run our comprehensive test suite.

🤝 Contributing

We welcome contributions from the community! netpulse-subnet is open-source and maintained actively.

Please read our Contributing Guidelines to understand how to clone the repository, use uv for dependency management, and submit your Pull Requests.

If you've found a bug or have a feature request, feel free to open an issue!

📜 License

Distributed under the MIT License. See LICENSE for more information.