invoiceguard 0.1.0__tar.gz

invoiceguard-0.1.0/LICENSE

@@ -0,0 +1,200 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      Use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We don't recommend using a
+      plain text file; if you use a plain text file, use the following
+      notice:
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

invoiceguard-0.1.0/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.4
+Name: invoiceguard
+Version: 0.1.0
+Summary: Freelancer payment enforcement: deposit links tied to a contract with a late-fee clause, then automated 3-stage collections.
+Author: InvoiceGuard contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/Bilal-Junaid-Jiwani/invoiceguard
+Keywords: freelance,invoicing,stripe,collections,dunning
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Environment :: Console
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: stripe<16,>=12
+Requires-Dist: PyYAML>=6
+Requires-Dist: click>=8
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn[standard]>=0.29
+Requires-Dist: python-multipart>=0.0.18
+Requires-Dist: jinja2>=3.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: httpx>=0.27; extra == "dev"
+Dynamic: license-file
+
+# InvoiceGuard
+
+**Freelancer payment enforcement: deposit links tied to a contract with a late-fee clause — then automated, escalating collections.**
+
+Solo freelancers don't get paid. A Kaplan Group report (April 2026) found **85% of freelancers experience late payment**; a Freelancers Union survey found **91%** have experienced late/overdue payments, with 54% waiting 3+ months. InvoiceGuard's wedge:
+
+1. **Before work starts:** generate a contract with a late-fee clause, create a Stripe deposit payment link. The client acknowledges the contract by accepting (paying) the deposit link.
+2. **After the due date:** an automated 3-stage email escalation — day-1 polite nudge → day-7 firm reminder → day-15 formal notice quoting the late-fee clause — until a Stripe webhook marks the invoice paid.
+
+Local-first (SQLite), open-source (Apache-2.0), works alongside your existing invoicing tools via Stripe. No platform switch required.
+
+> **Honest scope:** v1's "signature" is a client-acknowledgment checkbox (recorded when the deposit link is paid), not a legal e-signature. See [Limits of v1](#limits-of-v1).
+
+---
+
+## 5-minute quickstart
+
+**0. Install**
+
+```bash
+pip install invoiceguard
+# or, from a local clone:  pip install -r requirements.txt && pip install -e .
+invoiceguard init               # creates ~/.invoiceguard (config template, DB, email templates)
+```
+
+**1. Add your Stripe test key** (~2 min)
+
+1. Go to <https://dashboard.stripe.com/test/apikeys> (toggle **Test mode** on).
+2. **Developers → API keys → Create secret key**, copy the `sk_test_...` value.
+3. Paste it into `~/.invoiceguard/config.yaml` as `stripe_secret_key`, **or** export it:
+   ```bash
+   export INVOICEGUARD_STRIPE_SECRET_KEY="sk_test_..."
+   ```
+
+**2. Add your SMTP details** (~2 min) — how dunning emails are sent. In `~/.invoiceguard/config.yaml`:
+
+```yaml
+smtp:
+  host: "smtp.gmail.com"
+  port: 587
+  username: "you@example.com"
+  password: "YOUR_GMAIL_APP_PASSWORD"   # or export INVOICEGUARD_SMTP_PASSWORD
+  from_addr: "you@example.com"
+  use_tls: true
+```
+
+(Gmail: create an **App Password** at Google Account → Security → 2-Step Verification → App passwords. Any SMTP provider works.)
+
+**3. Create a client, project, and deposit link** (~1 min)
+
+```bash
+invoiceguard client add --name "Acme Corp" --email "billing@acme.com"
+
+invoiceguard project create --client "Acme Corp" --title "Website redesign" \
+  --amount 2000 --deposit-pct 50 --late-fee-pct 1.5 --ack
+# ^ generates the contract markdown (with the late-fee clause) and records
+#   client acknowledgment (--ack = client accepted the deposit link)
+
+invoiceguard invoice create --project 1 --kind deposit
+# => invoice #1 (deposit): $1,000.00
+#    pay link: https://buy.stripe.com/...
+#    due: 2026-10-07   status: sent
+```
+
+Send the pay link to the client. That's the whole pre-work flow.
+
+**4. Let collections run themselves**
+
+```bash
+# add to your crontab (runs the dunning scan every morning at 9:00):
+0 9 * * * /path/to/venv/bin/invoiceguard check-due >> ~/.invoiceguard/check-due.log 2>&1
+```
+
+`invoiceguard check-due` scans invoices past their due date and sends the next escalation stage (day1 → day7 → day15), using the editable markdown templates in `~/.invoiceguard/templates/`. It's idempotent — a stage is never sent twice for the same invoice. When the client pays, Stripe's webhook flips the invoice to `paid` automatically.
+
+**5. Stripe webhook (so payments mark invoices paid)**
+
+1. In the Stripe dashboard: **Developers → Webhooks → Add endpoint**.
+2. URL: `https://YOUR-HOST/webhooks/stripe` (the dashboard app serves this; see below).
+3. Select event: `checkout.session.completed`.
+4. Copy the **Signing secret** (`whsec_...`) into `stripe_webhook_secret` in the config (or export `INVOICEGUARD_STRIPE_WEBHOOK_SECRET`). The dashboard webhook reads the secret from the env var first, then the config file, then the legacy `STRIPE_WEBHOOK_SECRET` env var.
+
+---
+
+## CLI reference
+
+| Command | What it does |
+|---|---|
+| `invoiceguard init` | Create `~/.invoiceguard/` (config template, DB, email templates) |
+| `invoiceguard client add --name N --email E` | Add a client |
+| `invoiceguard client list` | List clients |
+| `invoiceguard project create --client N --title T --amount 2000 [--deposit-pct 50] [--late-fee-pct 1.5] [--late-fee-grace-days 15] [--ack]` | Create project + generate contract markdown |
+| `invoiceguard project ack ID` | Record client acknowledgment of the contract |
+| `invoiceguard project list` | List projects |
+| `invoiceguard invoice create --project ID --kind deposit\|milestone\|final [--amount X] [--due-days 7]` | Create a Stripe payment link (status → `sent`) |
+| `invoiceguard invoice list` | List invoices |
+| `invoiceguard invoice mark-paid ID` | Manually mark paid |
+| `invoiceguard invoice void ID` | Void an invoice |
+| `invoiceguard check-due` | Run the dunning scan (cron target) |
+| `invoiceguard dashboard [--port 8000]` | Launch the local web dashboard (`http://127.0.0.1:8000`) — invoice list, detail with escalation timeline, Stripe webhook receiver |
+
+Kind defaults: `deposit` = `deposit_pct`% of project total; `final` = remainder after deposit; `milestone` = full amount unless `--amount` overrides.
+
+## Configuration
+
+`~/.invoiceguard/config.yaml` (override path with `$INVOICEGUARD_CONFIG`; DB with `$INVOICEGUARD_DB`):
+
+```yaml
+stripe_secret_key: "sk_test_..."        # or INVOICEGUARD_STRIPE_SECRET_KEY
+stripe_webhook_secret: "whsec_..."       # or INVOICEGUARD_STRIPE_WEBHOOK_SECRET
+smtp:
+  host: "smtp.gmail.com"
+  port: 587
+  username: "you@example.com"
+  password: "APP_PASSWORD"              # or INVOICEGUARD_SMTP_PASSWORD
+  from_addr: "you@example.com"
+  use_tls: true
+app:
+  base_url: "http://localhost:8000"
+```
+
+Keys come **only** from config/env — never hardcoded, never committed (`.gitignore` covers `config.yaml`, `.env`, `*.key`, and the local DB).
+
+## Dunning templates
+
+`~/.invoiceguard/templates/day1.md`, `day7.md`, `day15.md` — plain markdown with `{variables}`:
+
+`{client_name}` `{project_title}` `{amount}` `{due_date}` `{days_overdue}` `{late_fee_pct}` `{pay_url}`
+
+Edit them freely; `check-due` picks them up on the next run. Stage timing: day1 fires at ≥1 day overdue, day7 at ≥7, day15 at ≥15 — earliest unsent due stage wins, one email per invoice per run.
+
+## Database schema (contract with the dashboard app)
+
+SQLite, default `~/.invoiceguard/invoiceguard.db`. The dashboard app reads/writes these exact tables — column names and types are frozen; additive migrations only:
+
+```sql
+CREATE TABLE clients(id INTEGER PRIMARY KEY, name TEXT NOT NULL, email TEXT, created_at TEXT NOT NULL);
+CREATE TABLE projects(id INTEGER PRIMARY KEY, client_id INTEGER NOT NULL REFERENCES clients(id), title TEXT NOT NULL, amount_cents INTEGER NOT NULL, currency TEXT NOT NULL DEFAULT 'USD', deposit_pct REAL NOT NULL DEFAULT 50.0, late_fee_pct REAL NOT NULL DEFAULT 1.5, late_fee_grace_days INTEGER NOT NULL DEFAULT 15, contract_md TEXT NOT NULL, contract_ack INTEGER NOT NULL DEFAULT 0, contract_ack_at TEXT, created_at TEXT NOT NULL);
+CREATE TABLE invoices(id INTEGER PRIMARY KEY, project_id INTEGER NOT NULL REFERENCES projects(id), kind TEXT NOT NULL, amount_cents INTEGER NOT NULL, currency TEXT NOT NULL DEFAULT 'USD', status TEXT NOT NULL DEFAULT 'draft', stripe_url TEXT, stripe_session_id TEXT, due_date TEXT, sent_at TEXT, paid_at TEXT, created_at TEXT NOT NULL);
+CREATE TABLE dunning_events(id INTEGER PRIMARY KEY, invoice_id INTEGER NOT NULL REFERENCES invoices(id), stage TEXT NOT NULL, sent_at TEXT NOT NULL);
+```
+
+kinds: `deposit | milestone | final`. statuses: `draft | sent | paid | overdue | void`. stages: `day1 | day7 | day15`.
+
+## Web dashboard
+
+`invoiceguard dashboard` launches the web dashboard for real — uvicorn serving
+`invoiceguard.web.main:app` (default `http://127.0.0.1:8000`, `--port` to
+change it). It shares this SQLite database: invoice list with status filters
+and escalation stages, per-invoice detail with a chronological timeline, and
+the `POST /webhooks/stripe` endpoint that marks invoices paid when Stripe
+reports a completed checkout session.
+
+Quick webhook smoke test (no network — the payload is signed locally):
+
+```bash
+INVOICEGUARD_DB=/tmp/ig-demo.db .venv/bin/python seed_demo.py --fresh
+INVOICEGUARD_DB=/tmp/ig-demo.db INVOICEGUARD_STRIPE_WEBHOOK_SECRET=whsec_test_x \
+  .venv/bin/invoiceguard dashboard
+# -> http://127.0.0.1:8000/  (Ctrl-C to stop)
+```
+
+## Docker
+
+```bash
+docker compose up -d                 # CLI container, data in the invoiceguard-data volume
+docker compose run --rm app check-due # one-off dunning scan
+```
+
+Put secrets in a `.env` file next to `docker-compose.yml` (never committed): `INVOICEGUARD_STRIPE_SECRET_KEY`, `INVOICEGUARD_STRIPE_WEBHOOK_SECRET`, `INVOICEGUARD_SMTP_PASSWORD`. Port 8000 is exposed for the dashboard.
+
+## Running tests
+
+```bash
+python -m venv .venv && .venv/bin/pip install -r requirements.txt && .venv/bin/pip install -e .
+.venv/bin/python -m pytest tests/ -q
+```
+
+54 tests, all green (2026-10-02): contract clause rendering, dunning stage selection + idempotency, template rendering, webhook signature verification (real HMAC check, offline), Stripe link creation (mocked SDK, params asserted), CLI flows, dashboard integration (page rendering + offline webhook checks incl. the `invoiceguard_invoice_id` metadata-key regression and the webhook-secret resolution regression: `INVOICEGUARD_STRIPE_WEBHOOK_SECRET` env / config-file secret honored, placeholder rejected), and a full end-to-end (init → client → project → invoice → `check-due` against a real local SMTP server → assert email captured + `dunning_events` row written).
+
+## Limits of v1
+
+- **No live Stripe call was verified in this build environment** — Stripe's connector isn't connected here. `invoice create` was verified with a mocked `stripe` SDK asserting the exact `PaymentLink.create` params (line items, price data, metadata); webhook handling was verified with **real** `stripe.Webhook.construct_event` signature verification using a test secret (works offline). You add your own test key (2 min, above) and the live path is standard Stripe API.
+- **v1 acknowledgment is a checkbox, not a signature.** Paying the deposit link = the client accepted the terms; `contract_ack=1` records it. Real e-signature is roadmap.
+- **Email deliverability is yours.** InvoiceGuard sends via *your* SMTP. Use a reputable provider (Gmail App Password, SendGrid, etc.) and warm up new addresses; check spam folders in testing.
+- **Late-fee enforceability varies by jurisdiction.** The clause is a contractual starting point, not legal advice. Adjust `late_fee_pct` / grace days per project.
+
+## Roadmap
+
+- **Real e-signature** — typed-name / drawn-signature capture on the contract, stored with the project.
+- **SMS / WhatsApp escalation** — day-15 via message, not just email.
+- **Agency mode** — multi-freelancer workspaces, per-client dunning policies.
+- Late-fee accrual calculator + ledger on the dashboard.
+- Partial payments / payment plans.
+
+## Changelog
+
+Release history lives in [CHANGELOG.md](CHANGELOG.md) — newest first, no fluff.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).

invoiceguard-0.1.0/README.md

@@ -0,0 +1,202 @@
+# InvoiceGuard
+
+**Freelancer payment enforcement: deposit links tied to a contract with a late-fee clause — then automated, escalating collections.**
+
+Solo freelancers don't get paid. A Kaplan Group report (April 2026) found **85% of freelancers experience late payment**; a Freelancers Union survey found **91%** have experienced late/overdue payments, with 54% waiting 3+ months. InvoiceGuard's wedge:
+
+1. **Before work starts:** generate a contract with a late-fee clause, create a Stripe deposit payment link. The client acknowledges the contract by accepting (paying) the deposit link.
+2. **After the due date:** an automated 3-stage email escalation — day-1 polite nudge → day-7 firm reminder → day-15 formal notice quoting the late-fee clause — until a Stripe webhook marks the invoice paid.
+
+Local-first (SQLite), open-source (Apache-2.0), works alongside your existing invoicing tools via Stripe. No platform switch required.
+
+> **Honest scope:** v1's "signature" is a client-acknowledgment checkbox (recorded when the deposit link is paid), not a legal e-signature. See [Limits of v1](#limits-of-v1).
+
+---
+
+## 5-minute quickstart
+
+**0. Install**
+
+```bash
+pip install invoiceguard
+# or, from a local clone:  pip install -r requirements.txt && pip install -e .
+invoiceguard init               # creates ~/.invoiceguard (config template, DB, email templates)
+```
+
+**1. Add your Stripe test key** (~2 min)
+
+1. Go to <https://dashboard.stripe.com/test/apikeys> (toggle **Test mode** on).
+2. **Developers → API keys → Create secret key**, copy the `sk_test_...` value.
+3. Paste it into `~/.invoiceguard/config.yaml` as `stripe_secret_key`, **or** export it:
+   ```bash
+   export INVOICEGUARD_STRIPE_SECRET_KEY="sk_test_..."
+   ```
+
+**2. Add your SMTP details** (~2 min) — how dunning emails are sent. In `~/.invoiceguard/config.yaml`:
+
+```yaml
+smtp:
+  host: "smtp.gmail.com"
+  port: 587
+  username: "you@example.com"
+  password: "YOUR_GMAIL_APP_PASSWORD"   # or export INVOICEGUARD_SMTP_PASSWORD
+  from_addr: "you@example.com"
+  use_tls: true
+```
+
+(Gmail: create an **App Password** at Google Account → Security → 2-Step Verification → App passwords. Any SMTP provider works.)
+
+**3. Create a client, project, and deposit link** (~1 min)
+
+```bash
+invoiceguard client add --name "Acme Corp" --email "billing@acme.com"
+
+invoiceguard project create --client "Acme Corp" --title "Website redesign" \
+  --amount 2000 --deposit-pct 50 --late-fee-pct 1.5 --ack
+# ^ generates the contract markdown (with the late-fee clause) and records
+#   client acknowledgment (--ack = client accepted the deposit link)
+
+invoiceguard invoice create --project 1 --kind deposit
+# => invoice #1 (deposit): $1,000.00
+#    pay link: https://buy.stripe.com/...
+#    due: 2026-10-07   status: sent
+```
+
+Send the pay link to the client. That's the whole pre-work flow.
+
+**4. Let collections run themselves**
+
+```bash
+# add to your crontab (runs the dunning scan every morning at 9:00):
+0 9 * * * /path/to/venv/bin/invoiceguard check-due >> ~/.invoiceguard/check-due.log 2>&1
+```
+
+`invoiceguard check-due` scans invoices past their due date and sends the next escalation stage (day1 → day7 → day15), using the editable markdown templates in `~/.invoiceguard/templates/`. It's idempotent — a stage is never sent twice for the same invoice. When the client pays, Stripe's webhook flips the invoice to `paid` automatically.
+
+**5. Stripe webhook (so payments mark invoices paid)**
+
+1. In the Stripe dashboard: **Developers → Webhooks → Add endpoint**.
+2. URL: `https://YOUR-HOST/webhooks/stripe` (the dashboard app serves this; see below).
+3. Select event: `checkout.session.completed`.
+4. Copy the **Signing secret** (`whsec_...`) into `stripe_webhook_secret` in the config (or export `INVOICEGUARD_STRIPE_WEBHOOK_SECRET`). The dashboard webhook reads the secret from the env var first, then the config file, then the legacy `STRIPE_WEBHOOK_SECRET` env var.
+
+---
+
+## CLI reference
+
+| Command | What it does |
+|---|---|
+| `invoiceguard init` | Create `~/.invoiceguard/` (config template, DB, email templates) |
+| `invoiceguard client add --name N --email E` | Add a client |
+| `invoiceguard client list` | List clients |
+| `invoiceguard project create --client N --title T --amount 2000 [--deposit-pct 50] [--late-fee-pct 1.5] [--late-fee-grace-days 15] [--ack]` | Create project + generate contract markdown |
+| `invoiceguard project ack ID` | Record client acknowledgment of the contract |
+| `invoiceguard project list` | List projects |
+| `invoiceguard invoice create --project ID --kind deposit\|milestone\|final [--amount X] [--due-days 7]` | Create a Stripe payment link (status → `sent`) |
+| `invoiceguard invoice list` | List invoices |
+| `invoiceguard invoice mark-paid ID` | Manually mark paid |
+| `invoiceguard invoice void ID` | Void an invoice |
+| `invoiceguard check-due` | Run the dunning scan (cron target) |
+| `invoiceguard dashboard [--port 8000]` | Launch the local web dashboard (`http://127.0.0.1:8000`) — invoice list, detail with escalation timeline, Stripe webhook receiver |
+
+Kind defaults: `deposit` = `deposit_pct`% of project total; `final` = remainder after deposit; `milestone` = full amount unless `--amount` overrides.
+
+## Configuration
+
+`~/.invoiceguard/config.yaml` (override path with `$INVOICEGUARD_CONFIG`; DB with `$INVOICEGUARD_DB`):
+
+```yaml
+stripe_secret_key: "sk_test_..."        # or INVOICEGUARD_STRIPE_SECRET_KEY
+stripe_webhook_secret: "whsec_..."       # or INVOICEGUARD_STRIPE_WEBHOOK_SECRET
+smtp:
+  host: "smtp.gmail.com"
+  port: 587
+  username: "you@example.com"
+  password: "APP_PASSWORD"              # or INVOICEGUARD_SMTP_PASSWORD
+  from_addr: "you@example.com"
+  use_tls: true
+app:
+  base_url: "http://localhost:8000"
+```
+
+Keys come **only** from config/env — never hardcoded, never committed (`.gitignore` covers `config.yaml`, `.env`, `*.key`, and the local DB).
+
+## Dunning templates
+
+`~/.invoiceguard/templates/day1.md`, `day7.md`, `day15.md` — plain markdown with `{variables}`:
+
+`{client_name}` `{project_title}` `{amount}` `{due_date}` `{days_overdue}` `{late_fee_pct}` `{pay_url}`
+
+Edit them freely; `check-due` picks them up on the next run. Stage timing: day1 fires at ≥1 day overdue, day7 at ≥7, day15 at ≥15 — earliest unsent due stage wins, one email per invoice per run.
+
+## Database schema (contract with the dashboard app)
+
+SQLite, default `~/.invoiceguard/invoiceguard.db`. The dashboard app reads/writes these exact tables — column names and types are frozen; additive migrations only:
+
+```sql
+CREATE TABLE clients(id INTEGER PRIMARY KEY, name TEXT NOT NULL, email TEXT, created_at TEXT NOT NULL);
+CREATE TABLE projects(id INTEGER PRIMARY KEY, client_id INTEGER NOT NULL REFERENCES clients(id), title TEXT NOT NULL, amount_cents INTEGER NOT NULL, currency TEXT NOT NULL DEFAULT 'USD', deposit_pct REAL NOT NULL DEFAULT 50.0, late_fee_pct REAL NOT NULL DEFAULT 1.5, late_fee_grace_days INTEGER NOT NULL DEFAULT 15, contract_md TEXT NOT NULL, contract_ack INTEGER NOT NULL DEFAULT 0, contract_ack_at TEXT, created_at TEXT NOT NULL);
+CREATE TABLE invoices(id INTEGER PRIMARY KEY, project_id INTEGER NOT NULL REFERENCES projects(id), kind TEXT NOT NULL, amount_cents INTEGER NOT NULL, currency TEXT NOT NULL DEFAULT 'USD', status TEXT NOT NULL DEFAULT 'draft', stripe_url TEXT, stripe_session_id TEXT, due_date TEXT, sent_at TEXT, paid_at TEXT, created_at TEXT NOT NULL);
+CREATE TABLE dunning_events(id INTEGER PRIMARY KEY, invoice_id INTEGER NOT NULL REFERENCES invoices(id), stage TEXT NOT NULL, sent_at TEXT NOT NULL);
+```
+
+kinds: `deposit | milestone | final`. statuses: `draft | sent | paid | overdue | void`. stages: `day1 | day7 | day15`.
+
+## Web dashboard
+
+`invoiceguard dashboard` launches the web dashboard for real — uvicorn serving
+`invoiceguard.web.main:app` (default `http://127.0.0.1:8000`, `--port` to
+change it). It shares this SQLite database: invoice list with status filters
+and escalation stages, per-invoice detail with a chronological timeline, and
+the `POST /webhooks/stripe` endpoint that marks invoices paid when Stripe
+reports a completed checkout session.
+
+Quick webhook smoke test (no network — the payload is signed locally):
+
+```bash
+INVOICEGUARD_DB=/tmp/ig-demo.db .venv/bin/python seed_demo.py --fresh
+INVOICEGUARD_DB=/tmp/ig-demo.db INVOICEGUARD_STRIPE_WEBHOOK_SECRET=whsec_test_x \
+  .venv/bin/invoiceguard dashboard
+# -> http://127.0.0.1:8000/  (Ctrl-C to stop)
+```
+
+## Docker
+
+```bash
+docker compose up -d                 # CLI container, data in the invoiceguard-data volume
+docker compose run --rm app check-due # one-off dunning scan
+```
+
+Put secrets in a `.env` file next to `docker-compose.yml` (never committed): `INVOICEGUARD_STRIPE_SECRET_KEY`, `INVOICEGUARD_STRIPE_WEBHOOK_SECRET`, `INVOICEGUARD_SMTP_PASSWORD`. Port 8000 is exposed for the dashboard.
+
+## Running tests
+
+```bash
+python -m venv .venv && .venv/bin/pip install -r requirements.txt && .venv/bin/pip install -e .
+.venv/bin/python -m pytest tests/ -q
+```
+
+54 tests, all green (2026-10-02): contract clause rendering, dunning stage selection + idempotency, template rendering, webhook signature verification (real HMAC check, offline), Stripe link creation (mocked SDK, params asserted), CLI flows, dashboard integration (page rendering + offline webhook checks incl. the `invoiceguard_invoice_id` metadata-key regression and the webhook-secret resolution regression: `INVOICEGUARD_STRIPE_WEBHOOK_SECRET` env / config-file secret honored, placeholder rejected), and a full end-to-end (init → client → project → invoice → `check-due` against a real local SMTP server → assert email captured + `dunning_events` row written).
+
+## Limits of v1
+
+- **No live Stripe call was verified in this build environment** — Stripe's connector isn't connected here. `invoice create` was verified with a mocked `stripe` SDK asserting the exact `PaymentLink.create` params (line items, price data, metadata); webhook handling was verified with **real** `stripe.Webhook.construct_event` signature verification using a test secret (works offline). You add your own test key (2 min, above) and the live path is standard Stripe API.
+- **v1 acknowledgment is a checkbox, not a signature.** Paying the deposit link = the client accepted the terms; `contract_ack=1` records it. Real e-signature is roadmap.
+- **Email deliverability is yours.** InvoiceGuard sends via *your* SMTP. Use a reputable provider (Gmail App Password, SendGrid, etc.) and warm up new addresses; check spam folders in testing.
+- **Late-fee enforceability varies by jurisdiction.** The clause is a contractual starting point, not legal advice. Adjust `late_fee_pct` / grace days per project.
+
+## Roadmap
+
+- **Real e-signature** — typed-name / drawn-signature capture on the contract, stored with the project.
+- **SMS / WhatsApp escalation** — day-15 via message, not just email.
+- **Agency mode** — multi-freelancer workspaces, per-client dunning policies.
+- Late-fee accrual calculator + ledger on the dashboard.
+- Partial payments / payment plans.
+
+## Changelog
+
+Release history lives in [CHANGELOG.md](CHANGELOG.md) — newest first, no fluff.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).