importguardpy 0.1.0__tar.gz

importguardpy-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,114 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+
+      - name: Run ruff linter
+        run: ruff check src/ tests/
+
+      - name: Run ruff formatter check
+        run: ruff format --check src/ tests/
+
+  typecheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mypy
+
+      - name: Run mypy
+        run: mypy src/importguard
+
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        exclude:
+          # Reduce CI time by testing fewer combinations
+          - os: macos-latest
+            python-version: "3.9"
+          - os: macos-latest
+            python-version: "3.10"
+          - os: windows-latest
+            python-version: "3.9"
+          - os: windows-latest
+            python-version: "3.10"
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest tests/ -v --tb=short
+
+      - name: Test CLI works
+        run: |
+          python -m importguard check json
+          python -m importguard check os --max-ms 5000
+
+      - name: Test JSON output
+        run: python -m importguard check json --json
+
+      - name: Test repeat functionality
+        run: python -m importguard check json --repeat 3 --max-ms 100
+
+  build:
+    runs-on: ubuntu-latest
+    needs: [lint, typecheck, test]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/

importguardpy-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,31 @@
+name: Publish to PyPI
+
+on:
+    release:
+        types: [published]
+
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+        environment: pypi
+        permissions:
+            id-token: write # Required for trusted publishing
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Set up Python
+              uses: actions/setup-python@v5
+              with:
+                  python-version: "3.11"
+
+            - name: Install build tools
+              run: pip install build
+
+            - name: Build package
+              run: python -m build
+
+            - name: Publish to PyPI
+              uses: pypa/gh-action-pypi-publish@release/v1
+              # Uses trusted publishing - no API token needed
+              # Configure at: https://pypi.org/manage/project/importguardpy/settings/publishing/

importguardpy-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+tests/__pycache__/
+src/__pycache__/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+.coverage.*
+.coverage.*.*
+.coverage.*.*.*
+.coverage.*.*.*.*
+.coverage.*.*.*.*.*
+__pycache__/
+dist

importguardpy-0.1.0/.importguard.toml

@@ -0,0 +1,15 @@
+[importguard]
+# Global budget for any module not explicitly configured
+max_total_ms = 500
+
+# Per-module budgets
+[importguard.budgets]
+"json" = 50
+"urllib.request" = 100
+"requests" = 200
+
+# Banned top-level imports per module
+[importguard.banned]
+"urllib.request" = ["ssl"]
+"requests" = ["pandas", "torch"]
+

importguardpy-0.1.0/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-01-01
+
+### Added
+
+- **CLI**: `importguard check <module>` command with full option support
+  - `--max-ms MS` — Fail if import exceeds time budget
+  - `--ban MODULE` — Ban modules from being imported (repeatable)
+  - `--config FILE` — Load `.importguard.toml` configuration
+  - `--top N` — Show top N slowest imports
+  - `--json` — Machine-readable JSON output for CI
+  - `--quiet` — Only output on failure
+  - `--repeat K` — Run K times, report median (reduces noise)
+  - `--python PATH` — Use specific Python interpreter
+
+- **Configuration**: `.importguard.toml` support
+  - Global `max_total_ms` budget
+  - Per-module budgets via `[importguard.budgets]`
+  - Per-module banned imports via `[importguard.banned]`
+  - Auto-discovery walking up directory tree
+
+- **Python API**: `check_import()` function
+  - Returns `ImportResult` with full timing data
+  - Supports `max_ms`, `banned`, `repeat`, `python_path` parameters
+  - Accepts both `list` and `set` for banned modules
+
+- **Core Engine**
+  - Uses Python's `-X importtime` for accurate timing
+  - Wall-clock backup measurement via `time.perf_counter_ns()`
+  - Runs in isolated subprocess (no interpreter pollution)
+  - Handles import failures gracefully
+
+- **CI Integration**
+  - GitHub Actions workflow example
+  - Pre-commit hook example
+  - JSON output for machine parsing
+  - Warnings for near-budget imports
+
+- **Documentation**
+  - Comprehensive README with examples
+  - "Why Results Differ on CI?" troubleshooting guide
+  - "How to Keep Imports Fast" best practices
+
+### Technical Details
+
+- Zero runtime dependencies
+- Python 3.9+ support
+- Full type annotations (mypy strict)
+- 64+ test cases
+
+[0.1.0]: https://github.com/AryanKumar1401/importguard/releases/tag/v0.1.0
+

importguardpy-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Aryan Kumar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+