pybgpkit-parser 0.6.1__tar.gz → 0.7.0__tar.gz

pybgpkit_parser-0.7.0/.github/workflows/release.yml

@@ -0,0 +1,102 @@
+name: Release
+
+permissions:
+  contents: write
+  id-token: write
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+"
+  workflow_dispatch:
+    inputs:
+      publish:
+        description: "Publish artifacts to PyPI (manual runs default to build-only)"
+        required: true
+        type: boolean
+        default: false
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run format check
+        run: cargo fmt --check
+      - name: Run clippy
+        run: cargo clippy -- -D warnings
+
+  build-sdist:
+    needs: checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  build-wheels:
+    needs: checks
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: x86_64
+          - os: macos-15
+            target: x86_64
+          - os: macos-latest
+            target: aarch64
+          - os: windows-latest
+            target: x64
+    steps:
+      - uses: actions/checkout@v4
+      - uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}-${{ matrix.target }}
+          path: dist/*.whl
+
+  publish-pypi:
+    needs: [build-sdist, build-wheels]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' || inputs.publish == true
+    environment: pypi
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist
+          skip-existing: true
+
+  create-release:
+    needs: [build-sdist, build-wheels, publish-pypi]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          body_path: CHANGELOG.md

pybgpkit_parser-0.7.0/.github/workflows/rust.yaml

@@ -0,0 +1,36 @@
+name: Rust
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  rust-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run format check
+        run: cargo fmt --check
+      - name: Run clippy
+        run: cargo clippy -- -D warnings
+
+  python-api:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install test tools
+        run: python -m pip install --upgrade pip maturin pytest pytest-benchmark
+      - name: Build wheel
+        run: maturin build --release --out dist
+      - name: Install built wheel
+        run: python -m pip install --force-reinstall dist/*.whl
+      - name: Run Python API tests (unit)
+        run: pytest tests/test_api.py -v

{pybgpkit_parser-0.6.1 → pybgpkit_parser-0.7.0}/.gitignore

@@ -17,3 +17,7 @@ venv
 cache
 
 .DS_Store
+
+.pypirc
+__pycache__/
+*.py[cod]

pybgpkit_parser-0.7.0/AGENTS.md

@@ -0,0 +1,83 @@
+# PROJECT KNOWLEDGE BASE
+
+## OVERVIEW
+
+Python binding for `bgpkit-parser` (Rust MRT/BGP parser). Exposes `Parser` (full elems), `RouteParser` (route-level scans), `Filter` helpers, and projected tuple iteration via PyO3, built with maturin.
+
+## STRUCTURE
+
+```
+├── src/lib.rs          # Entire Python extension: Parser/elem/route PyO3 classes
+├── examples/           # Python usage examples
+├── Cargo.toml          # Rust crate: pybgpkit-parser, depends on bgpkit-parser
+├── pyproject.toml      # Maturin build-system config
+├── build.rs            # PyO3 extension module linker setup
+├── benches/            # Rust criterion benchmarks
+├── tests/              # Python API tests and benchmark
+└── .github/workflows/  # Rust fmt/clippy CI + tag-based release
+```
+
+## WHERE TO LOOK
+
+| Task | Location |
+|------|----------|
+| Change exposed Python API | `src/lib.rs` |
+| Update underlying parser logic | `Cargo.toml` → bump `bgpkit-parser` version |
+| Build/test locally | `maturin develop` (see README.md) |
+| Build wheels for release | GitHub Actions `release.yml` (push `v*` tag) |
+| Publish to PyPI | Push `v*` tag; CI publishes via PyPI Trusted Publishing (OIDC) |
+
+## CODE MAP
+
+- **`Elem`** — PyO3 class wrapping a parsed BGP element. Has `#[pyo3(get, set)]` fields and `to_dict()` / `__str__` / `__getstate__` methods.
+- **`Parser`** — PyO3 class wrapping `bgpkit_parser::BgpkitParser`. Constructor takes `url`, optional `filters` (HashMap), and optional `cache_dir`. Implements `__iter__`/`__next__`, `count`, `iter_batches`, `iter_tuples`, and `iter_tuple_batches`.
+- **`RouteParser`** — PyO3 class wrapping `BgpkitParser::into_route_iter()`. Returns lightweight `RouteElem` values. Same iteration/helper surface as `Parser`.
+- **`Filter`** — PyO3 class wrapping `bgpkit_parser::parser::Filter`. Constructors: `__init__`, `peer_ip`, `peer_ips`, `origin_asn`, `prefix`, `elem_type`.
+- **`TupleIterator` / `TupleBatchIterator`** — High-performance projected tuple iteration for `Parser` and `RouteParser`.
+- **`convert_elem`** — Internal fn mapping `BgpElem` → `Elem` (Rust type → PyO3 type).
+
+## CONVENTIONS
+
+- Rust fmt/clippy enforced in CI (`cargo fmt --check`, `cargo clippy -- -D warnings`)
+- `PyValueError` used for filter errors propagated to Python
+- Iterator-backed pyclasses use `#[pyclass(unsendable)]`; no `unsafe impl Send/Sync`
+- `#[pyo3(name = "__str__")]` used for JSON string representation of `Elem`
+- `atomic` field returns `"AG"`/`"NAG"` strings (not bool)
+- `elem_type` field returns `"A"` (announce) or `"W"` (withdraw)
+
+## ANTI-PATTERNS
+
+- **Do NOT** change PyO3/maturin versions without updating both `Cargo.toml` and `build.rs` (`pyo3-build-config` must match)
+- **Do NOT** test release publishing with a beta tag unless the package version is also beta; use `workflow_dispatch` with `publish=false` for build-only checks
+- **Do NOT** add long-lived PyPI API tokens; use PyPI Trusted Publishing with GitHub OIDC (`environment: pypi`)
+- **Do NOT** add `unsafe impl Send/Sync` to `#[pyclass]` types; use `#[pyclass(unsendable)]` instead
+- **Do NOT** use `.unwrap()` on user inputs (URL/filters); already handled in `BgpkitParser::new` but be careful with new additions
+- **Do NOT** make `Elem` fields write-only or remove getters without noting in CHANGELOG as breaking (v0.6.0 was a breaking change)
+
+## COMMANDS
+
+```bash
+# Local dev build (installs to active venv)
+maturin develop
+
+# Build wheel locally
+maturin build --release
+
+# Build and publish release via CI
+git tag v0.7.0
+git push origin v0.7.0
+
+# Format + lint
+cargo fmt --check
+cargo clippy -- -D warnings
+
+# Publish (after building on all platforms)
+twine upload --skip-existing target/wheels/*
+```
+
+## NOTES
+
+- `bgpkit-parser` crate version bump is the primary release trigger (see CHANGELOG for version history)
+- Release workflow: `rust.yaml` runs Rust + Python API checks on PR/push; `release.yml` builds ABI3 wheels and publishes on `v*` tag push via Trusted Publishing
+- Supports Python 3.9+ via ABI3 wheels
+- Python API tests live in `tests/test_api.py`; network smoke coverage is gated by `PYBGPKIT_RUN_NETWORK_TESTS=1`

pybgpkit_parser-0.7.0/BUILD.md

@@ -0,0 +1,66 @@
+# Build and Publish Guide
+
+## Automated Release (Recommended)
+
+Release builds are handled by GitHub Actions via `.github/workflows/release.yml`.
+
+Push a version tag to build and publish:
+
+```bash
+git tag v0.7.0
+git push origin v0.7.0
+```
+
+The release workflow will:
+
+1. Run `cargo fmt --check` and `cargo clippy -- -D warnings`
+2. Build the source distribution (`sdist`)
+3. Build ABI3 wheels for:
+   - Linux x86_64
+   - macOS x86_64
+   - macOS arm64
+   - Windows x86_64
+4. Publish artifacts to PyPI using PyPI Trusted Publishing (OIDC)
+5. Create a GitHub Release and attach the built artifacts
+
+Manual workflow runs (`workflow_dispatch`) are build-only by default. They only publish when the `publish` input is explicitly enabled.
+
+## PyPI Trusted Publishing Setup
+
+Configure a trusted publisher for the existing `pybgpkit-parser` PyPI project:
+
+| Field | Value |
+|------|-------|
+| Owner | `bgpkit` |
+| Repository name | `bgpkit-parser-py` |
+| Workflow name | `release.yml` |
+| Environment name | `pypi` |
+
+The workflow uses GitHub Actions OIDC (`id-token: write`) and does not require a long-lived PyPI API token.
+
+## Local Development Build
+
+```bash
+maturin develop
+```
+
+This builds the extension and installs it into the active Python environment.
+
+## Local Wheel Build
+
+```bash
+maturin build --release
+```
+
+Built wheels are written under `target/wheels/`.
+
+## Manual Publish Fallback
+
+If CI is unavailable, build locally and upload with `twine`:
+
+```bash
+python -m pip install --upgrade maturin twine
+maturin build --release --sdist
+twine upload --skip-existing target/wheels/*
+```
+

pybgpkit_parser-0.7.0/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 0.7.0 - 2026-06-09
+
+### Highlights
+
+* Update `bgpkit-parser` to v0.17.0.
+* Update PyO3 to v0.28 and enable ABI3 wheels for Python 3.9+.
+* Add `peer_bgp_id` and `only_to_customer` fields to `Elem`.
+* Add reusable `Filter` class and `Parser.from_filters(...)` constructor.
+* Add Rust-like `Elem` utility methods: `is_announcement`, `is_withdrawal`, `get_origin_asn`, `get_origin_asns`, `has_as_path`, `as_dict`, `to_json`, `to_psv`, and `get_psv_header`.
+* Add `Elem.origin_asn` property and module constants `ELEM_TYPE_ANNOUNCE`, `ELEM_TYPE_WITHDRAW`, and `PSV_HEADER`.
+* Add Python-native filter helper constructors: `Filter.peer_ip`, `Filter.peer_ips`, `Filter.origin_asn`, `Filter.prefix`, and `Filter.elem_type`.
+* Add stream-consuming `Parser.count()` and `Parser.iter_batches(batch_size)` helpers.
+* Add `RouteElem` and `RouteParser` for upstream route-level parsing (`BgpRouteElem`) and faster route identity scans.
+* Add high-performance projected tuple iteration: `iter_tuples(fields)` and `iter_tuple_batches(fields, batch_size)` for `Parser` and `RouteParser`.
+* Add field presets `BASIC_FIELDS`, `ROUTE_FIELDS`, and `NEXT_HOP_FIELDS`.
+* Optimize `Parser.parse_all()` and batch iteration by parsing while detached from the Python interpreter before converting results into Python objects.
+* Add Rust and Python benchmark scaffolding.
+* Automate wheel builds and PyPI publishing via GitHub Actions.
+
+## 0.6.2 - 2025-06-06
+
+### Fix regressions
+
+* Fix a regression in the `Elem` class that the default string representation was missing
+* Fix a regression that the `Parser` class requires `filters` and `cache_dir` to be passed in the constructor,
+  which should be and was optional priority to `v0.6.0`.
+
+## 0.6.1 - 2025-06-06
+
+### Highlights
+
+* Update `bgpkit-parser` to v0.11.1, which includes a fix on parsing for `next_hop` for IPv6 peers.
+
+## 0.6.0 - 2025-06-04
+
+### Highlights
+
+* Update `bgpkit-parser` to v0.11.0, which includes several bug fixes and performance improvements.
+* Add support for Python 3.13.
+
+### Breaking changes
+
+* The `Elem` class's fields can only be access by their getter methods now. Direct access to fields is no longer
+  allowed. This change improves encapsulation and ensures that the internal state of `Elem` is managed correctly.
+
+## 0.5.1 - 2024-02-28
+
+### Highlights
+
+* update `bgpkit-parser` to v0.10.1, which fixes a performance regression introduced in 0.10.0.
+