pydependencycheck 1.4.0__tar.gz

pydependencycheck-1.4.0/.github/INSTALL.md

@@ -0,0 +1,58 @@
+# Installation Guide
+
+## Quick Install
+
+```bash
+pip install pydependencycheck
+```
+
+## Requirements
+
+- Python 3.10+
+- macOS 10.13+, Ubuntu 20.04+, Windows 10+
+
+## Installation
+
+### Standard Install (Recommended)
+Works for most users with prebuilt wheels:
+```bash
+pip install pydependencycheck
+```
+
+### From Source (If Needed)
+For ARM or custom builds:
+```bash
+# Install Rust
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+
+# Then install
+pip install pydependencycheck
+```
+
+## Troubleshooting
+
+### "No wheels available for your platform"
+```bash
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+pip install --force-reinstall pydependencycheck
+```
+
+### Python version issues
+Ensure Python 3.10+:
+```bash
+python --version
+```
+
+### Missing dependencies (Linux)
+```bash
+sudo apt-get install python3-dev build-essential
+```
+
+## Next Steps
+
+After installation:
+1. See [README.md](../README.md) for quick start
+2. Check [examples/](../examples/) for usage examples
+3. Read [docs/](../docs/) for full documentation
+
+For more help, see [full installation guide](INSTALL.md).

pydependencycheck-1.4.0/.github/workflows/ci.yml

@@ -0,0 +1,119 @@
+name: CI
+
+on:
+  push:
+    branches: [main, develop]
+  pull_request:
+    branches: [main, develop]
+
+jobs:
+  rust-tests:
+    name: Rust Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: x86_64-unknown-linux-gnu
+
+      - name: Cache cargo registry
+        uses: actions/cache@v3
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cache cargo index
+        uses: actions/cache@v3
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Cache cargo build
+        uses: actions/cache@v3
+        with:
+          path: target
+          key: ${{ runner.os }}-cargo-build-target-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Run tests
+        run: cargo test --workspace --verbose
+
+      - name: Run doc tests
+        run: cargo test --doc --workspace
+
+      - name: Clippy
+        run: cargo clippy --workspace -- -D warnings
+
+      - name: Format check
+        run: cargo fmt --check
+
+  python-tests:
+    name: Python Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Set up Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      # maturin develop requires an active virtualenv/conda env to install
+      # into and doesn't create one itself. Put its bin/ on $GITHUB_PATH so
+      # every later step in this job (pip installs, maturin, pytest) uses
+      # it automatically.
+      - name: Create virtualenv
+        run: |
+          python -m venv .venv
+          echo "$PWD/.venv/bin" >> "$GITHUB_PATH"
+          echo "VIRTUAL_ENV=$PWD/.venv" >> "$GITHUB_ENV"
+
+      - name: Install maturin
+        run: pip install maturin
+
+      - name: Install dependencies
+        run: |
+          pip install -e .[dev]
+          pip install click pydantic gitpython
+
+      - name: Build extension
+        run: maturin develop --release
+
+      - name: Run tests
+        run: pytest tests/ -v --cov=pydependencycheck
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./coverage.xml
+
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install linting tools
+        run: |
+          pip install black ruff mypy
+
+      - name: Run black
+        run: black --check python/
+
+      - name: Run ruff
+        run: ruff check python/
+
+      - name: Run mypy
+        run: mypy python/pydependencycheck --ignore-missing-imports || true

pydependencycheck-1.4.0/.github/workflows/wheels.yml

@@ -0,0 +1,111 @@
+name: Build & Test Wheels
+
+on:
+  push:
+    branches: [main]
+    tags: ['v*']
+  pull_request:
+    branches: [main]
+
+jobs:
+  build-wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-latest
+            target: x86_64
+
+          # Both macOS legs run on macos-14 (Apple Silicon). The Intel leg
+          # used to run natively on macos-13, but that image was queuing
+          # forever with zero progress -- the same "no runner capacity"
+          # signature the previously-retired macos-12 showed (confirmed:
+          # the other 3 matrix legs on the same run completed in minutes
+          # while this one sat queued for 25+ minutes). Rather than chase
+          # whichever specific macOS image happens to still be hosted,
+          # cross-compile the Intel wheel from Apple Silicon via
+          # maturin-action, which doesn't depend on an actual Intel runner
+          # existing.
+          - os: macos-14
+            target: aarch64-apple-darwin
+          - os: macos-14
+            target: x86_64-apple-darwin
+
+          - os: windows-latest
+            target: x86_64
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      # maturin-action manages its own Rust toolchain for the macOS legs;
+      # the Linux/Windows "native" path below calls `python -m build`
+      # directly and needs rustc on PATH itself.
+      - name: Set up Rust
+        if: runner.os != 'macOS'
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Build wheels (macOS, via maturin-action for cross-compilation)
+        if: runner.os == 'macOS'
+        uses: PyO3/maturin-action@v1
+        env:
+          PYO3_USE_ABI3_FORWARD_COMPATIBILITY: "1"
+        with:
+          target: ${{ matrix.target }}
+          args: --release --out dist
+
+      - name: Build wheels (Linux/Windows, native)
+        if: runner.os != 'macOS'
+        env:
+          PYO3_USE_ABI3_FORWARD_COMPATIBILITY: "1"
+        run: |
+          pip install --upgrade pip
+          pip install maturin wheel build
+          python -m build --wheel
+
+      - name: Install dependencies for testing
+        run: |
+          pip install pytest click pydantic gitpython rich requests
+
+      - name: Test wheels
+        # Skip on the cross-compiled Intel-from-ARM leg -- the wheel is
+        # built for a different CPU architecture than this runner, so it
+        # cannot actually be installed/imported here.
+        if: matrix.target != 'x86_64-apple-darwin'
+        run: |
+          pip install dist/*.whl
+          pytest tests/ -v || true
+
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}-${{ matrix.target }}
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: build-wheels
+    if: startsWith(github.ref, 'refs/tags/v')
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist/
+
+      - name: Flatten artifacts
+        run: |
+          find dist -type f -name "*.whl" -exec mv {} dist/ \;
+          find dist -type d -empty -delete
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

pydependencycheck-1.4.0/.gitignore

@@ -0,0 +1,72 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Virtual environments
+venv/
+env/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Rust
+target/
+Cargo.lock
+**/*.rs.bk
+
+# Build artifacts
+*.o
+*.a
+*.rlib
+*.dylib
+*.dll
+*.exe
+
+# Project-specific
+.pydep/
+.pydependencycheck.yaml.local
+*.db
+*.sqlite3
+
+# OS
+.DS_Store
+.AppleDouble
+.LSOverride
+*.sublime-project
+*.sublime-workspace
+
+# Logs
+*.log
+logs/

pydependencycheck-1.4.0/CONTRIBUTING.md

@@ -0,0 +1,140 @@
+# Contributing to PyDependencyCheck
+
+Thanks for your interest in contributing! This guide covers development setup, testing, and the submission process.
+
+## Development Setup
+
+### Prerequisites
+- Rust 1.75+ (`rustup update`)
+- Python 3.8+ (3.10+ recommended)
+- Git
+
+### Clone & Build
+
+```bash
+git clone https://github.com/Mullassery/PyDependencyCheck
+cd PyDependencyCheck
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # or `venv\Scripts\activate` on Windows
+
+# Install development dependencies
+pip install -e .[dev]
+pip install maturin
+
+# Build Rust extension
+maturin develop --release
+```
+
+### Running Tests
+
+```bash
+# Rust tests (fast)
+cargo test --workspace
+
+# Python tests (with coverage)
+pytest tests/ -v --cov=pydependencycheck
+
+# All checks
+cargo fmt
+cargo clippy
+black python/
+ruff python/
+```
+
+## Project Structure
+
+```
+PyDependencyCheck/
+├── crates/                  # Rust workspace
+│   ├── pydep-parser/        # Dependency file parsing
+│   ├── pydep-graph/         # Graph algorithms (petgraph)
+│   ├── pydep-ast/           # Code analysis (tree-sitter)
+│   ├── pydep-security/      # OSV integration, scoring
+│   └── pydep-py/            # PyO3 bindings
+├── python/
+│   └── pydependencycheck/   # Python package
+│       ├── cli.py           # Click CLI
+│       ├── scanner.py       # Main scanner
+│       ├── reporters.py     # Output generators
+│       ├── storage.py       # SQLite layer
+│       └── git_integration.py
+├── tests/                   # Test files
+├── docs/                    # Documentation
+└── pyproject.toml           # Maturin config
+```
+
+## Coding Standards
+
+### Rust
+- Format: `cargo fmt`
+- Lint: `cargo clippy -- -D warnings`
+- Tests: Unit tests in each crate, integration tests in `tests/`
+
+### Python
+- Format: `black python/` (line length 120)
+- Lint: `ruff python/` (E, F, W, I)
+- Type hints: Encouraged but not required (mypy friendly)
+
+## Adding a Feature
+
+### 1. Create an Issue
+Describe what you want to build and why.
+
+### 2. Design Phase
+- Small features: Direct to PR
+- Large features: Open a Design Discussion first
+
+### 3. Development
+- Create a feature branch: `git checkout -b feat/your-feature`
+- Write tests first (TDD encouraged)
+- Keep commits small and focused
+
+### 4. Testing
+- Rust: `cargo test --workspace`
+- Python: `pytest tests/ -v`
+- Integration: End-to-end test with real projects
+
+### 5. Pull Request
+- Link to the issue
+- Describe changes clearly
+- Ensure CI passes (GitHub Actions)
+- Request review from maintainers
+
+## Common Tasks
+
+### Adding a Dependency Parser
+1. Create parser module in `crates/pydep-parser/src/`
+2. Implement `parse_xyz_file()` function
+3. Update `lib.rs` to export it
+4. Add integration test in `tests/`
+
+### Adding a CLI Command
+1. Add function to `python/pydependencycheck/cli.py`
+2. Decorate with `@cli.command()`
+3. Write docstring with examples
+4. Test: `pydependencycheck --help`
+
+### Improving Performance
+1. Profile with `cargo flamegraph` or `py-spy`
+2. Add benchmark test
+3. Document improvements in PR
+
+## Release Process
+
+1. **Version bump:** Edit `Cargo.toml` + `pyproject.toml`
+2. **Changelog:** Update `CHANGELOG.md`
+3. **Tag:** `git tag v0.1.0`
+4. **Push:** GitHub Actions builds wheels automatically
+5. **PyPI:** Artifacts published to PyPI
+
+## Getting Help
+
+- **Discussions:** [GitHub Discussions](https://github.com/Mullassery/PyDependencyCheck/discussions)
+- **Issues:** [Report a bug](https://github.com/Mullassery/PyDependencyCheck/issues)
+- **Email:** mullassery@gmail.com
+
+---
+
+**Contributor Agreement:** By submitting code, you agree it will be licensed under the Proprietary License. See LICENSE for details.