UPIF-Demo / DEPLOYMENT_GUIDE.md
yashsecdev's picture
Initial commit: UPIF v0.1.4 and Marketing Demo
5e56bcf
# UPIF Launch Manual πŸš€
You have the code. Now you need a business.
Here is your Roadmap to Revenue.
## Phase 1: Commercial Setup (Gumroad) πŸ’°
1. **Create Product**: Go to [Gumroad](https://gumroad.com/). Create a product named "UPIF Pro License".
* Type: "Digital Product" or "Membership".
* Price: $99/mo or $500/lifetime.
2. **Get Keys**:
* Go to **Settings > Advanced > Application**.
* Copy the `Application ID` and `Application Secret`.
* *Wait!* Our code actually uses the **Product Permalink** or simple License Key verification endpoint.
3. **Update Code**:
* Open `upif/core/licensing.py`.
* Update `PRODUCT_PERMALINK` with your Gumroad product URL slug.
* (Optional) If you want tighter security, implement `verify_license` using the official Gumroad Python client, but our current `requests` implementation is standard.
## Phase 2: The AI Brain (The "Pro" Feature) 🧠
Your `NeuralGuard` needs a brain. You cannot ship an empty ONNX file.
1. **Select a Model**:
* Recommended: **`microsoft/deberta-v3-small`** (Fast, good at intent) or **`ProtectAI/deberta-v3-base-prompt-injection`** (Specialized).
2. **Convert to ONNX**:
```bash
pip install optimum[onnxruntime]
optimum-cli export onnx --model ProtectAI/deberta-v3-base-prompt-injection upif/data/
```
* Rename the model to `guard_model.onnx`.
3. **Ship It**:
* Place `guard_model.onnx` inside `upif/data/`.
* Ensure `MANIFEST.in` includes `*.onnx`.
## Phase 3: Public Release (PyPI) πŸ“¦
Distribute the **Open Core** to the world.
1. **Build**:
```bash
python dev_tools/build.py
```
* This creates a `.whl` in `dist/`.
2. **Test Upload** (TestPyPI):
```bash
pip install twine
twine upload --repository testpypi dist/*
```
3. **Go Live**:
```bash
twine upload dist/*
```
* Your users can now `pip install upif`.
## Phase 4: Marketing πŸ“’
* **Demo**: Use the CLI in your sales videos.
* `upif scan "Ignore instructions"` -> **BLOCKED**.
* **Docs**: Host the `INTEGRATION_GUIDE.md` on a nice secure documentation site (GitBook/Mintlify).
**Good luck, CEO.**