feat: IP extension types, extract_ips filters, defang support, and mkdocs API reference (#17)

Author: erichutchins

.github/workflows/docs.yml

@@ -1,8 +1,8 @@
-name: ci 
+name: ci
 on:
   push:
     branches:
-      - master 
+      - master
       - main
 permissions:
   contents: write
@@ -15,15 +15,16 @@ jobs:
         run: |
           git config user.name github-actions[bot]
           git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+          python-version: "3.12"
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
       - uses: actions/cache@v4
         with:
           key: mkdocs-material-${{ env.cache_id }}
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material 
-      - run: mkdocs gh-deploy --force
+      - run: uv sync --group docs
+      - run: uv run mkdocs gh-deploy --force

.github/workflows/publish_to_pypi.yml

@@ -16,9 +16,9 @@ concurrency:
 permissions:
   contents: read # Default read-only permissions
 
-# Make sure CI fails on all warnings, including Clippy lints
+# Treat all Rust warnings as errors; skip debug symbols to reduce compile time/memory
 env:
-  RUSTFLAGS: "-Dwarnings"
+  RUSTFLAGS: "-Dwarnings -C debuginfo=0"
 
 jobs:
   # ------------------------------------------------------------------
@@ -30,7 +30,6 @@ jobs:
       fail-fast: false
       matrix:
         python-version:
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
@@ -46,11 +45,14 @@ jobs:
 
       - name: Rust Cache
         uses: swatinem/rust-cache@v2
+        with:
+          save-if: ${{ github.ref_name == 'main' }}
 
       - name: Install uv and Python
         uses: astral-sh/setup-uv@v5
         with:
           python-version: ${{ matrix.python-version }}
+          enable-cache: true
 
       - name: install deps
         run: uv sync --group dev
@@ -64,41 +66,6 @@ jobs:
       - name: Run tests
         run: uv run pytest tests -v
 
-  # ------------------------------------------------------------------
-  # Minimum version test (py3.9 + polars 1.3)
-  # ------------------------------------------------------------------
-  min-versions-test:
-    name: Test Min Versions (Python 3.9)
-    runs-on: ubuntu-latest
-    needs: test-python
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Set up Rust stable toolchain
-        uses: dtolnay/rust-toolchain@stable
-
-      - name: Rust Cache
-        uses: swatinem/rust-cache@v2
-
-      - name: Install uv and Python
-        uses: astral-sh/setup-uv@v5
-        with:
-          python-version: "3.9"
-
-      - name: Install with minimum dependencies
-        run: |
-          uv sync --group dev
-          uv lock --upgrade-package polars==1.3.0
-
-      - run: uv pip install -e .
-        env:
-          RUST_BACKTRACE: 1
-
-      - run: uv pip freeze
-
-      - name: Run tests with minimum versions
-        run: uv run pytest tests -v
-
   # ------------------------------------------------------------------
   # Test different operating systems
   # ------------------------------------------------------------------
@@ -119,9 +86,14 @@ jobs:
 
       - name: cache rust
         uses: Swatinem/rust-cache@v2
+        with:
+          save-if: ${{ github.ref_name == 'main' }}
 
       - name: install uv
         uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.12"
+          enable-cache: true
 
       - name: install deps
         run: uv sync --group dev
@@ -139,7 +111,7 @@ jobs:
   # ------------------------------------------------------------------
   build-linux:
     name: Build Wheels (${{ matrix.os }}, ${{ matrix.target }})
-    needs: [test-python, test-os, min-versions-test]
+    needs: [test-python, test-os]
     runs-on: ${{ matrix.platform.runner }}
 
     strategy:
@@ -176,7 +148,7 @@ jobs:
 
   build-musllinux:
     name: Build Wheels (${{ matrix.os }}, ${{ matrix.target }})
-    needs: [test-python, test-os, min-versions-test]
+    needs: [test-python, test-os]
     runs-on: ${{ matrix.platform.runner }}
 
     strategy:
@@ -212,7 +184,7 @@ jobs:
 
   build-windows:
     name: Build Wheels (${{ matrix.os }}, ${{ matrix.target }})
-    needs: [test-python, test-os, min-versions-test]
+    needs: [test-python, test-os]
     runs-on: ${{ matrix.platform.runner }}
 
     strategy:
@@ -246,7 +218,7 @@ jobs:
 
   build-macos:
     name: Build Wheels (${{ matrix.os }}, ${{ matrix.target }})
-    needs: [test-python, test-os, min-versions-test]
+    needs: [test-python, test-os]
     runs-on: ${{ matrix.platform.runner }}
 
     strategy:

AGENTS.md

@@ -0,0 +1,4 @@
+Follow the Python Developer Tooling Handbook's recommendations:
+- Use uv for all dependency management
+- Reference: https://pydevtools.com/handbook/explanation/modern-python-project-setup-guide-for-ai-assistants.md
+- For more information: https://pydevtools.com/llms.txt