netintent 0.0.1__py3-none-any.whl

netintent/__init__.py

@@ -0,0 +1,7 @@
+"""netintent: intent-driven network configuration and operations toolkit."""
+
+from netintent.loader import load_fabric
+from netintent.models import Device, Endpoint, Fabric, Link, Role
+
+__all__ = ["Device", "Endpoint", "Fabric", "Link", "Role", "load_fabric"]
+__version__ = "0.0.1"

netintent/cli.py

@@ -0,0 +1,45 @@
+"""Validate network intent before it reaches a device."""
+
+from __future__ import annotations
+
+import argparse
+import sys
+
+import yaml
+from pydantic import ValidationError
+
+from netintent import __version__
+from netintent.loader import load_fabric
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(prog="netintent", description=__doc__)
+    parser.add_argument("--version", action="version", version=f"netintent {__version__}")
+    sub = parser.add_subparsers(dest="command", required=True)
+    val = sub.add_parser("validate", help="validate a fabric intent file")
+    val.add_argument("file")
+    args = parser.parse_args(argv)
+
+    if args.command == "validate":
+        try:
+            fabric = load_fabric(args.file)
+        except FileNotFoundError:
+            print(f"error: file not found: {args.file}", file=sys.stderr)
+            return 2
+        except yaml.YAMLError as exc:
+            print(f"error: invalid YAML: {exc}", file=sys.stderr)
+            return 2
+        except ValidationError as exc:
+            print(f"INVALID: {args.file}", file=sys.stderr)
+            for err in exc.errors():
+                loc = ".".join(str(p) for p in err["loc"]) or "fabric"
+                print(f"  - {loc}: {err['msg']}", file=sys.stderr)
+            return 1
+        print(
+            f"OK: fabric '{fabric.name}' - {len(fabric.devices)} devices, {len(fabric.links)} links"
+        )
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

netintent/loader.py

@@ -0,0 +1,19 @@
+"""Load fabric intent from YAML."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import yaml
+
+from netintent.models import Fabric
+
+
+def load_fabric(path: str | Path) -> Fabric:
+    """Parse and validate a fabric intent file.
+
+    Raises pydantic.ValidationError if the intent is invalid.
+    """
+    with Path(path).open(encoding="utf-8") as fh:
+        data = yaml.safe_load(fh)
+    return Fabric.model_validate(data)

netintent/models.py

@@ -0,0 +1,125 @@
+"""Intent model for an eBGP Clos fabric.
+
+v0.0.1 scope: describe devices and point-to-point links, and reject intent that
+cannot be built. Configuration rendering comes in later releases.
+"""
+
+from __future__ import annotations
+
+from enum import StrEnum
+from ipaddress import IPv4Interface, IPv4Network
+from typing import Annotated
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
+
+# 4-byte ASN range (RFC 6793). 0 and 4294967295 are reserved (RFC 7300).
+ASN = Annotated[int, Field(ge=1, le=4294967294)]
+Name = Annotated[str, Field(min_length=1, max_length=63, pattern=r"^[A-Za-z0-9][A-Za-z0-9._-]*$")]
+
+
+class Role(StrEnum):
+    SPINE = "spine"
+    LEAF = "leaf"
+    BORDER = "border"
+
+
+class _Strict(BaseModel):
+    model_config = ConfigDict(extra="forbid", frozen=True)
+
+
+class Device(_Strict):
+    name: Name
+    role: Role
+    asn: ASN
+    loopback: IPv4Interface
+
+    @field_validator("loopback")
+    @classmethod
+    def loopback_is_host_route(cls, v: IPv4Interface) -> IPv4Interface:
+        if v.network.prefixlen != 32:
+            raise ValueError(f"loopback {v} must be a /32")
+        return v
+
+
+class Endpoint(_Strict):
+    device: Name
+    interface: Annotated[str, Field(min_length=1)]
+
+
+class Link(_Strict):
+    a: Endpoint
+    b: Endpoint
+    subnet: IPv4Network
+
+    @field_validator("subnet")
+    @classmethod
+    def subnet_is_p2p(cls, v: IPv4Network) -> IPv4Network:
+        if v.prefixlen != 31:
+            raise ValueError(f"link subnet {v} must be a /31 (RFC 3021)")
+        return v
+
+    @model_validator(mode="after")
+    def not_a_loop(self) -> Link:
+        if self.a.device == self.b.device:
+            raise ValueError(f"link {self.subnet} connects {self.a.device} to itself")
+        return self
+
+
+class Fabric(_Strict):
+    name: Name
+    devices: list[Device] = Field(min_length=1)
+    links: list[Link] = Field(default_factory=list)
+
+    @model_validator(mode="after")
+    def check_consistency(self) -> Fabric:
+        errors: list[str] = []
+
+        by_name: dict[str, Device] = {}
+        for d in self.devices:
+            if d.name in by_name:
+                errors.append(f"duplicate device name: {d.name}")
+            by_name[d.name] = d
+
+        seen_lo: dict[IPv4Interface, str] = {}
+        for d in self.devices:
+            if d.loopback in seen_lo:
+                errors.append(f"loopback {d.loopback} used by {seen_lo[d.loopback]} and {d.name}")
+            seen_lo[d.loopback] = d.name
+
+        used_ports: set[tuple[str, str]] = set()
+        subnets: list[IPv4Network] = []
+        for link in self.links:
+            for ep in (link.a, link.b):
+                if ep.device not in by_name:
+                    errors.append(f"link {link.subnet} references unknown device {ep.device}")
+                port = (ep.device, ep.interface)
+                if port in used_ports:
+                    errors.append(
+                        f"interface {ep.device}:{ep.interface} used by more than one link"
+                    )
+                used_ports.add(port)
+
+            for other in subnets:
+                if link.subnet.overlaps(other):
+                    errors.append(f"link subnet {link.subnet} overlaps {other}")
+            subnets.append(link.subnet)
+
+            for d in self.devices:
+                if d.loopback.ip in link.subnet:
+                    errors.append(f"loopback of {d.name} falls inside link subnet {link.subnet}")
+            a, b = by_name.get(link.a.device), by_name.get(link.b.device)
+            if a and b:
+                if a.role == b.role and a.role in (Role.SPINE, Role.LEAF):
+                    errors.append(
+                        f"{a.role}-to-{b.role} link {a.name}-{b.name} "
+                        "is not valid in a 3-stage Clos fabric"
+                    )
+                if a.asn == b.asn:
+                    errors.append(
+                        f"link {a.name}-{b.name} joins two devices in AS {a.asn}; "
+                        "eBGP peers need different ASNs"
+                    )
+
+        if errors:
+            raise ValueError("; ".join(errors))
+        return self

netintent-0.0.1.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.5
+Name: netintent
+Version: 0.0.1
+Summary: Intent-driven network configuration and operations toolkit
+Project-URL: Repository, https://github.com/samwilliamsjebaraj/netintent
+Project-URL: Issues, https://github.com/samwilliamsjebaraj/netintent/issues
+Author: Sam Williams Jebaraj
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: bgp,clos,intent-based networking,network automation,source of truth
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: System Administrators
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Networking
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.6
+Requires-Dist: pyyaml>=6.0
+Description-Content-Type: text/markdown
+
+# netintent
+
+Intent-driven network configuration and operations toolkit.
+
+> **Status: pre-alpha (v0.0.1).** The API will change. Not for production use yet.
+
+## What it does today
+
+`netintent` validates the intent for an eBGP Clos fabric before anything reaches a device. It rejects intent that cannot be built:
+
+- Loopbacks that are not /32, or are duplicated
+- Link subnets that are not /31 (RFC 3021), or that overlap
+- Links to unknown devices, self-loops, and interfaces used by more than one link
+- Loopbacks that fall inside a link subnet
+- Same-tier links (spine-to-spine, leaf-to-leaf) in a 3-stage Clos fabric
+- Links between two devices in the same AS, which cannot form an eBGP session
+- Invalid or reserved ASNs, and unknown fields
+
+Spines may share an ASN, as in the RFC 7938 design.
+
+## Install
+
+```bash
+pip install netintent
+```
+
+## Usage
+
+```bash
+netintent validate examples/clos-small.yaml
+# OK: fabric 'lab-fabric' - 4 devices, 4 links
+```
+
+```python
+from netintent import load_fabric
+
+fabric = load_fabric("examples/clos-small.yaml")
+print([d.name for d in fabric.devices])
+```
+
+## Roadmap
+
+- Configuration rendering for multiple vendors from validated intent
+- Source-of-truth integration
+- Operational state checks against intent
+- An evaluated AI triage layer for fabric faults, with a public benchmark
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+uv run ruff check . && uv run mypy src
+```
+
+This project is developed with AI assistance. All code is specified, reviewed, and tested by the maintainer.
+
+## License
+
+Apache-2.0

netintent-0.0.1.dist-info/RECORD

@@ -0,0 +1,10 @@
+netintent/__init__.py,sha256=lEggHu50nsqxylv23ebV1zHoGi4JNnV9ZlCsKRuUx0Y,282
+netintent/cli.py,sha256=HHXOIw5LOXFGG68ungg2m9kDAx5_r2wt5TdPcsWi0Q0,1506
+netintent/loader.py,sha256=dLOfNyXB6S9vmY1_Sd91TIoDixH5_vQmYuEgXf4DfYM,437
+netintent/models.py,sha256=9I1LSDwgZ2uOUZJ5GH9l-gIDqz4CQHmKDT8eU3TXnuM,4126
+netintent/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+netintent-0.0.1.dist-info/METADATA,sha256=ku_lNDpwU2JeAgQkHid8uylp_wLiy_4bwi-GsPHvOug,2582
+netintent-0.0.1.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+netintent-0.0.1.dist-info/entry_points.txt,sha256=ZXbUG2JB0xU5UBQ89RgRcrzHRcsPWMaRXNpWoqea-K8,49
+netintent-0.0.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+netintent-0.0.1.dist-info/RECORD,,

netintent-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

netintent-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+netintent = netintent.cli:main

netintent-0.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.