mirror of
https://github.com/smittix/intercept.git
synced 2026-04-24 06:40:00 -07:00
Add uv installation instructions and update pyproject.toml
- Add uv quick start option to README (collapsible section) - Add Python Dependencies section to HARDWARE.md with multiple options: - setup.sh (recommended) - pip with requirements.txt - uv with uv sync - pip with pyproject.toml - Update pyproject.toml: - Bump version to 1.1.0 - Add pyserial to dependencies - Add project URLs
This commit is contained in:
13
README.md
13
README.md
@@ -49,6 +49,19 @@ sudo python3 intercept.py
|
||||
|
||||
Open http://localhost:5050 in your browser.
|
||||
|
||||
<details>
|
||||
<summary><strong>Alternative: Install with uv</strong></summary>
|
||||
|
||||
```bash
|
||||
git clone https://github.com/smittix/intercept.git
|
||||
cd intercept
|
||||
uv venv
|
||||
source .venv/bin/activate # On Windows: .venv\Scripts\activate
|
||||
uv sync
|
||||
sudo python3 intercept.py
|
||||
```
|
||||
</details>
|
||||
|
||||
> **Note:** Requires Python 3.9+ and external tools. See [Hardware & Installation](docs/HARDWARE.md).
|
||||
|
||||
---
|
||||
|
||||
@@ -123,3 +123,41 @@ rtl_test
|
||||
# LimeSDR/HackRF
|
||||
SoapySDRUtil --find
|
||||
```
|
||||
|
||||
## Python Dependencies
|
||||
|
||||
### Option 1: setup.sh (Recommended)
|
||||
```bash
|
||||
./setup.sh
|
||||
```
|
||||
This creates a virtual environment and installs dependencies automatically.
|
||||
|
||||
### Option 2: pip
|
||||
```bash
|
||||
python3 -m venv .venv
|
||||
source .venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Option 3: uv (Fast alternative)
|
||||
[uv](https://github.com/astral-sh/uv) is a fast Python package installer.
|
||||
|
||||
```bash
|
||||
# Install uv (if not already installed)
|
||||
curl -LsSf https://astral.sh/uv/install.sh | sh
|
||||
|
||||
# Create venv and install deps
|
||||
uv venv
|
||||
source .venv/bin/activate # On Windows: .venv\Scripts\activate
|
||||
uv sync
|
||||
|
||||
# Or just install deps in existing environment
|
||||
uv pip install -r requirements.txt
|
||||
```
|
||||
|
||||
### Option 4: pip with pyproject.toml
|
||||
```bash
|
||||
pip install . # Install as package
|
||||
pip install -e . # Install in editable mode (for development)
|
||||
pip install -e ".[dev]" # Include dev dependencies
|
||||
```
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "intercept"
|
||||
version = "1.0.0"
|
||||
version = "1.1.0"
|
||||
description = "Signal Intelligence Platform - Pager/433MHz/ADS-B/Satellite/WiFi/Bluetooth"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.9"
|
||||
@@ -28,8 +28,14 @@ classifiers = [
|
||||
dependencies = [
|
||||
"flask>=2.0.0",
|
||||
"skyfield>=1.45",
|
||||
"pyserial>=3.5",
|
||||
]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://github.com/smittix/intercept"
|
||||
Repository = "https://github.com/smittix/intercept"
|
||||
Issues = "https://github.com/smittix/intercept/issues"
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"pytest>=7.0.0",
|
||||
|
||||
Reference in New Issue
Block a user