Skip to content

Commit 9d27200

Browse files
author
Vijay Vardhan Kondani
committed
Add requirements.txt, CI, and real sample output to the README
1 parent e824c77 commit 9d27200

5 files changed

Lines changed: 40 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- uses: actions/setup-python@v5
16+
with:
17+
python-version: "3.11"
18+
cache: "pip"
19+
20+
- name: Install dependencies
21+
run: pip install -r requirements.txt
22+
23+
- name: Compile check
24+
run: python -m compileall -q .

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
# PinForge
22

3+
[![CI](https://github.com/vijaxx/pinforge/actions/workflows/ci.yml/badge.svg)](https://github.com/vijaxx/pinforge/actions/workflows/ci.yml)
4+
![Python](https://img.shields.io/badge/python-3.11-blue)
5+
[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
6+
37
A small pipeline that turns one word-search theme into a sellable digital product line: a print-ready PDF pack, a set of Pinterest pin creatives, SEO copy for each pin, and a manifest tying it all together — then posts the pins and tracks how they perform.
48

59
Pinterest is used here as a free, search-driven discovery channel (pins rank in search for months, no audience required, no per-listing fees) that feeds a Gumroad storefront. It's built to run unattended: given a theme name it renders puzzles, builds the PDF, generates pin art, writes SEO copy, and can post directly through an attached Chrome session.
610

11+
## Sample output
12+
13+
<table><tr>
14+
<td><img src="docs/sample-pin.png" width="320" alt="Sample Pinterest pin"><br><sub>A generated Pinterest pin — real puzzle grid, not a mockup</sub></td>
15+
<td><img src="docs/sample-cover.png" width="320" alt="Sample Gumroad cover"><br><sub>Storefront cover art for the same product</sub></td>
16+
</tr></table>
17+
718
## How it fits together
819

920
```
@@ -31,6 +42,7 @@ Python, Pillow (pin rendering), reportlab + pypdf (PDF generation/merging), SQLi
3142
## Running it
3243

3344
```
45+
pip install -r requirements.txt
3446
python3 factory.py --theme animals # build one product line
3547
python3 factory.py --all # build every configured theme
3648
./ensure_chrome_pinforge.sh # bring up the dedicated Chrome profile

docs/sample-cover.png

59.2 KB
Loading

docs/sample-pin.png

110 KB
Loading

requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Pillow
2+
pypdf
3+
reportlab
4+
websocket-client

0 commit comments

Comments
 (0)