Open-source Markdown
README.md and skill file.
This page mirrors the public repository Markdown so reviewers can inspect the workflow logic without leaving the portfolio site.
README.md
# Creator Outreach AI Kit
Consent-aware creator outreach planner for cross-border brands that work with
TikTok, Reels, Shorts, Amazon and Shopify content creators.
This repo is built for a practical FDE workflow:
```text
creator leads
-> fit score
-> channel eligibility
-> email draft
-> WhatsApp handoff only when permitted
-> follow-up queue
-> result memory
```
It is not a spam bot. It does not automate WhatsApp Web, scrape logged-in
platforms, bypass rate limits, or mass-send unsolicited DMs. The default output is
a reviewable plan with drafts and manual next actions.
## What It Does
- Scores creators by niche, market, engagement, platform fit and brand-safety notes.
- Drafts creator emails with clear product context, deliverables and opt-out copy.
- Creates WhatsApp handoff links only when the lead is marked as opted-in or
user-initiated.
- Blocks risky WhatsApp actions when there is no consent signal.
- Builds a follow-up queue that keeps the workflow useful without hiding consent.
## Quick Start
```bash
python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e .
creator-outreach plan examples/sample_creators.json examples/sample_campaign.json
```
Run tests:
```bash
python -m unittest discover -s tests
```
## Input Shape
`examples/sample_creators.json`:
```json
[
{
"name": "Mia Home Finds",
"platform": "TikTok",
"market": "US",
"niche": "home gadget",
"followers": 86000,
"engagement_rate": 0.061,
"email": "mia@example.com",
"whatsapp": "+15550001111",
"whatsapp_status": "opted_in",
"notes": ["strong demo hooks", "family-safe"]
}
]
```
## Open Source Reference Map
This repository is original code. It uses the following projects as architecture
references, not copied source:
- [Chatwoot](https://github.com/chatwoot/chatwoot): open-source customer engagement
and conversation-routing patterns.
- [Mautic](https://github.com/mautic/mautic): open-source marketing automation
workflow inspiration.
- [listmonk](https://github.com/knadh/listmonk): newsletter/list management and
campaign hygiene inspiration.
- [MJML](https://github.com/mjmlio/mjml): responsive email template ecosystem.
## Compliance Position
For email, include clear identity, relevant reason, and opt-out handling. For
WhatsApp, use official business channels or manual handoff only with consent or a
user-initiated conversation. For social platforms, do not scrape private or logged-in
data; import lawful lead lists or public observations and keep review gates.
## License
MIT.
skills/creator-outreach.skill.md
# creator-outreach.skill
Purpose: plan creator outreach for cross-border commerce without turning the
workflow into spam automation.
## Loop
```text
intake campaign
-> import lawful creator list
-> score creator fit
-> check channel eligibility
-> draft email
-> WhatsApp handoff only with consent
-> log reply / sample / post result
-> update creator memory
```
## Required Inputs
- Product name, category, market and target platform.
- Creator list with source, email, WhatsApp status and notes.
- Offer and deliverables.
- Compliance notes such as restricted claims.
## Output
- Ranked creator list.
- Email draft per eligible creator.
- WhatsApp link only for opted-in or user-initiated contacts.
- Follow-up step and risk notes.
## Hard Rules
- Do not automate WhatsApp Web.
- Do not mass-send DMs.
- Do not scrape logged-in social pages.
- Do not contact opted-out leads.
- Keep a human review gate before sending.