flowcvcli 0.2.0__py3-none-any.whl

flowcvcli/resume.py

@@ -0,0 +1,122 @@
+"""Resume-level operations: listing, create/duplicate/rename/delete, PDF
+download, web-resume publish/status.
+
+ResumeMixin is a pure mixin over Client (see client.py): no __init__, all
+state lives on `self`. Write methods return the JSON envelope dict so callers
+can check `env["success"]`.
+"""
+import json
+import uuid
+
+# Top-level resume fields that must NOT be copied into a new resume: server
+# regenerates them (unique tokens / timestamps). `id` and `uuid` are reassigned.
+_NEW_RESUME_DROP = ("webToken", "feedbackToken", "createdAt", "updatedAt", "lastChangeAt")
+
+
+class ResumeMixin:
+    # ---- listing ----------------------------------------------------------
+    def list_resumes(self):
+        """GET /resumes/all -> the list of resume summaries. Raises on failure."""
+        env = self.request("resumes/all")
+        if not env.get("success"):
+            raise SystemExit(f"list resumes failed: {env}")
+        return env["data"]["resumes"]
+
+    # ---- create / duplicate / rename / delete -----------------------------
+    def _create_from(self, title, keep_content):
+        """Create a new resume by cloning the current one's full object.
+
+        FlowCV's `create` needs a complete resume object (every NOT-NULL column),
+        so we clone the current resume — guaranteeing validity — then reassign a
+        fresh id/uuid, drop the unique tokens (server regenerates), and set the
+        title. `keep_content=False` makes a blank resume that keeps the same
+        identity (personalDetails) and design (customization); `keep_content=True`
+        is a full duplicate. Returns the new resume id.
+        """
+        src = self.get_resume()
+        clone = json.loads(json.dumps(src))    # deep copy
+        new_id = str(uuid.uuid4())
+        clone["id"] = new_id
+        clone["uuid"] = str(uuid.uuid4())
+        clone["title"] = title
+        for k in _NEW_RESUME_DROP:
+            clone.pop(k, None)
+        if not keep_content:
+            clone["content"] = {}
+        env = self.request("resumes/create", method="POST", body={"clientResume": clone})
+        if not env.get("success"):
+            raise SystemExit(f"create resume failed: {json.dumps(env)[:200]}")
+        return new_id
+
+    def create_resume(self, title):
+        """Create a new, empty resume (same contact details & styling, no content).
+        Returns the new resume id."""
+        return self._create_from(title, keep_content=False)
+
+    def duplicate_resume(self, title=None):
+        """Duplicate the current resume (content and all). Returns the new id."""
+        if title is None:
+            title = (self.get_resume().get("title") or "Resume") + " (copy)"
+        return self._create_from(title, keep_content=True)
+
+    def rename_resume(self, title):
+        """PATCH /resumes/rename_resume — set the resume's title."""
+        return self.request("resumes/rename_resume", method="PATCH",
+                            body={"resumeId": self.resume_id, "resumeTitle": title})
+
+    def delete_resume(self, resume_id=None):
+        """DELETE /resumes/delete_resume — permanently delete a resume.
+
+        Defaults to the configured resume; pass an explicit id to delete another.
+        Irreversible — the CLI guards this behind --yes.
+        """
+        rid = resume_id or self.resume_id
+        return self.request("resumes/delete_resume", method="DELETE", query={"resumeId": rid})
+
+    # ---- PDF --------------------------------------------------------------
+    def download_pdf(self, pages=10):
+        """GET /resumes/download -> PDF bytes. Raises unless a 200 + %PDF body."""
+        status, raw = self.request_raw(
+            "resumes/download",
+            query={"resumeId": self.resume_id, "previewPageCount": pages},
+        )
+        if status != 200 or not raw.startswith(b"%PDF"):
+            raise SystemExit(f"download failed: HTTP {status}, {raw[:80]!r}")
+        return raw
+
+    def save_pdf(self, path, pages=10):
+        """Download the resume PDF and write it to `path`; return `path`."""
+        with open(path, "wb") as f:
+            f.write(self.download_pdf(pages))
+        return path
+
+    def download_public(self, token):
+        """Download ANY public/shared resume's PDF by its web token (no ownership needed)."""
+        status, raw = self.request_raw("public/download_resume", query={"token": token})
+        if status != 200 or not raw.startswith(b"%PDF"):
+            raise SystemExit(f"public download failed: HTTP {status}, {raw[:80]!r}")
+        return raw
+
+    # ---- web resume -------------------------------------------------------
+    def publish(self):
+        """PATCH /resumes/publish_web_resume to make the web resume public."""
+        return self.request("resumes/publish_web_resume", method="PATCH",
+                            body={"publish": True, "resumeId": self.resume_id})
+
+    def unpublish(self):
+        """PATCH /resumes/publish_web_resume to take the web resume offline."""
+        return self.request("resumes/publish_web_resume", method="PATCH",
+                            body={"publish": False, "resumeId": self.resume_id})
+
+    def web_status(self):
+        """Return {live, url} for the public web resume (url None if no token)."""
+        r = self.get_resume()
+        token = r.get("webToken")
+        return {
+            "live": r.get("webResumeLive"),
+            "url": "https://flowcv.com/resume/" + token if token else None,
+        }
+
+    def share_url(self):
+        """Return the public web-resume URL (or None if no webToken)."""
+        return self.web_status()["url"]

flowcvcli-0.2.0.dist-info/METADATA

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: flowcvcli
+Version: 0.2.0
+Summary: Control a FlowCV resume from the command line or Python — content, design, templates, photo, publish and PDF export — via FlowCV's private JSON API. Zero dependencies.
+Author: dannyota
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/dannyota/flowcvcli
+Project-URL: Repository, https://github.com/dannyota/flowcvcli
+Project-URL: Documentation, https://github.com/dannyota/flowcvcli/blob/main/docs/API.md
+Project-URL: Issues, https://github.com/dannyota/flowcvcli/issues
+Keywords: flowcv,resume,cv,cli,resume-builder,json-api,automation
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# flowcvcli
+
+[![PyPI](https://img.shields.io/pypi/v/flowcvcli.svg)](https://pypi.org/project/flowcvcli/)
+[![Python](https://img.shields.io/pypi/pyversions/flowcvcli.svg)](https://pypi.org/project/flowcvcli/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+Control a [FlowCV](https://flowcv.com) resume from the **command line** or from
+**Python** — content, header & links, **customization**, **templates**,
+**avatar**, reorder/hide, multi-resume management, publish, and **PDF export**.
+It drives FlowCV's private JSON API (the same calls the web app makes), so it
+works for any FlowCV resume with your own session. **Zero dependencies** (Python
+standard library only), so it's easy to drop into scripts and LLM agents.
+
+> Unofficial and not affiliated with FlowCV. It uses FlowCV's undocumented
+> internal API and may break if that changes; use it with your own account and at
+> your own risk (mind FlowCV's Terms of Service). See [`docs/API.md`](docs/API.md)
+> for the reverse-engineered API and [`docs/RENDERING.md`](docs/RENDERING.md) for
+> how the editor renders the live preview and persists edits.
+
+## Install
+
+```bash
+pip install flowcvcli          # installs the `flowcv` command
+```
+
+Or run from source without installing:
+
+```bash
+git clone https://github.com/dannyota/flowcvcli && cd flowcvcli
+python3 flowcv.py --help       # equivalent to the `flowcv` command
+```
+
+## Configure
+
+Put a `.env` in the directory you run `flowcv` from (or in
+`~/.config/flowcvcli/.env`). Real environment variables override it.
+
+```dotenv
+# Auth — pick ONE:
+FLOWCV_COOKIE=flowcvsidapp=s%3A...     # your session cookie, OR
+# FLOWCV_EMAIL=you@example.com         # log in with credentials instead
+# FLOWCV_PASSWORD=...                  #   (session cached to ~/.config/flowcvcli/session)
+
+# FLOWCV_RESUME_ID=...                 # optional; only if your account has several resumes
+```
+
+- **Cookie**: DevTools → Application → Cookies → `app.flowcv.com` → copy the
+  `flowcvsidapp` value. That single cookie is the auth.
+- **Credentials**: with `FLOWCV_EMAIL` + `FLOWCV_PASSWORD` the tool logs in and
+  caches the session (re-login is automatic when the cookie expires). The cache
+  is written `0600` to `~/.config/flowcvcli/session` (override with
+  `$FLOWCV_SESSION_FILE`).
+- **Resume id** is optional: with one resume it's auto-selected; with several,
+  set `FLOWCV_RESUME_ID` or pass `--resume-id <id>` (run `flowcv resumes` to list).
+
+## CLI
+
+```bash
+flowcv resumes                       # list resumes (id, title, share token)
+flowcv show [section]                # sections + entries (ids, labels, dates)
+flowcv dump <section> <id>           # one entry, fields + rich text
+
+# manage resumes (multi-resume / paid plans)
+flowcv new "My Second Resume"        # new resume (same details+style, no content) -> prints id
+flowcv duplicate ["Copy title"]      # full copy of the current resume
+flowcv rename "New Title"            # rename the current resume
+flowcv delete-resume --yes           # permanent (refuses without --yes)
+
+# content (markdown mini-format below); `add` creates the section if needed
+flowcv add work --set title="Engineer" --set company="Acme" \
+       --set start=01/2022 --set end=Present --text $'- Did a measurable thing.'
+flowcv desc work <id> --file role.md
+flowcv field work <id> employer --text "Acme Corp"
+flowcv rm work <id>
+
+# reorder / hide / sections
+flowcv reorder work <id3> <id1> <id2>     # set entry order (all of the section's ids)
+flowcv hide work <id> ; flowcv show-entry work <id>
+flowcv rename-section skill "Core Skills"
+flowcv section-icon skill head-side-brain
+flowcv rm-section custom1 --yes           # delete a section + its entries
+flowcv reorder-sections profile work skill education   # one-column order
+
+# header details & links (links are social entries: orcid, googlescholar, github…)
+flowcv pd jobTitle --text "Security Leader"
+flowcv link orcid ORCID https://orcid.org/0000-0000-0000-0000
+flowcv unlink orcid ; flowcv links
+
+# avatar
+flowcv avatar set https://example.com/me.png   # upload from URL or file
+flowcv avatar on | off | remove
+
+# styling (a delta into resume.customization) and templates
+flowcv customize font.fontFamily "Source Sans Pro"
+flowcv customize colors.basic.single '"#0e374e"'
+flowcv templates                     # lists each as [free] / [PAID] (paid needs a subscription)
+flowcv apply-template <templateId>   # warns first if the template is paid
+
+# render & share
+flowcv download -o resume.pdf        # the rendered PDF
+flowcv download --token <webToken> -o out.pdf   # any PUBLIC resume by its share token (no auth)
+flowcv share | publish | unpublish
+
+flowcv login                          # refresh the cached session
+flowcv md2html --file role.md         # preview HTML (offline)
+```
+
+Any command takes `--resume-id <id>` to target a specific resume. (From source,
+replace `flowcv` with `python3 flowcv.py`.)
+
+## Library (for scripts & LLM agents)
+
+```python
+from flowcvcli import FlowCV
+
+fc = FlowCV()                                   # or FlowCV(resume_id="...")
+fc.set_personal_field("fullName", "Jane Doe")
+fc.add_entry("work", sets={"jobTitle": "Engineer", "employer": "Acme",
+                           "startDateNew": "01/2022", "endDateNew": "Present"},
+             md="- Shipped a thing with **measurable** impact.")
+fc.set("font.fontFamily", "Source Sans Pro")    # a customization delta
+fc.set_photo("https://example.com/me.png")      # avatar from URL
+fc.apply_template("a3fb6c37-...")               # a design from list_templates()
+fc.save_pdf("resume.pdf")                        # render to PDF
+
+# structure & resume management
+fc.reorder_entries("work", ["id3", "id1", "id2"])   # set entry order
+fc.rename_section("skill", "Core Skills"); fc.delete_section("custom1")
+fc.hide_entry("work", "id", hidden=True)
+new_id = fc.create_resume("Second Resume")          # or fc.duplicate_resume()
+fc.rename_resume("New Title"); fc.delete_resume()    # delete is permanent
+```
+
+### Build → render → check → improve
+
+The PDF *is* the rendered output. An agent can write content, `save_pdf(...)`,
+**open the PDF to see the actual layout**, then adjust and re-render — a closed
+feedback loop for building a resume from raw info.
+
+## Markdown mini-format (`desc` / `add`)
+
+| You write | You get |
+|---|---|
+| blank line | block separator |
+| `## Heading` / `**Whole line bold**` | bold subheader |
+| `- item` | bullet (consecutive = one list) |
+| anything else | justified paragraph |
+| `**bold**` inline | `<strong>bold</strong>` |
+
+## How it works
+
+- **Read-modify-write**: edits fetch the resume, change one part, and send it
+  back — unrelated fields are never touched.
+- New entries append to the bottom of their section; use `reorder` to change order.
+- The on-screen preview is client-side HTML; the **PDF download is a separate
+  server render** of the same data (details in [`docs/RENDERING.md`](docs/RENDERING.md)).
+
+> **Scope:** this tool covers **resumes**. The same FlowCV account also has Cover
+> Letters, Job Tracker, Email Signatures and Personal Websites (separate APIs —
+> see `docs/API.md` "Other FlowCV products"); documented but not implemented here.
+
+## Project layout
+
+```
+flowcvcli/             # the package (import flowcvcli)
+  config.py            #   resolve resume id + auth from .env / env vars
+  client.py            #   HTTP, login, cookie-jar session, retry, get_resume
+  markup.py            #   markdown <-> FlowCV rich-text HTML
+  content.py           #   sections & entries (add/edit/reorder/hide/sections)
+  personal.py          #   header details & links
+  customization.py     #   styling deltas & templates
+  photo.py             #   avatar upload / toggle
+  resume.py            #   list, create/duplicate/rename/delete, download, publish
+  api.py               #   FlowCV = Client + all mixins
+  cli.py / __main__.py #   the `flowcv` command
+docs/API.md            # reverse-engineered API reference
+docs/RENDERING.md      # how the editor renders the preview & debounces saves
+flowcv.py              # source-tree entry point (python3 flowcv.py …)
+```
+
+## License
+
+[MIT](LICENSE) © dannyota

flowcvcli-0.2.0.dist-info/RECORD

@@ -0,0 +1,18 @@
+flowcvcli/__init__.py,sha256=x-8Y0Y2l1JAsBFthqIMytVGwTs40a2N5Hqtyk7cyJYA,329
+flowcvcli/__main__.py,sha256=vswlkf5GlOpZWRnJCMyo3nxdNHjfpV64MfTlpoyqg6k,140
+flowcvcli/api.py,sha256=fsTgehgjBJjLKVs4l3Ph21M8Yp8kA0-MZIdofv3M3Ho,1335
+flowcvcli/cli.py,sha256=z1quLav3fBlzlQPcuG9udoq-KEcYzecet6QckMG1oaE,12541
+flowcvcli/client.py,sha256=mK6Tn2axUaR2C07aoeSr6Qo5VGl8qB-aoY3h4csqD2g,13130
+flowcvcli/config.py,sha256=EC-et6QjOVwDc7zGK6Dr50uNWJ27iOmqFKjF7_gyR3Q,3246
+flowcvcli/content.py,sha256=hEJWM2OHVa74WBwuS5tYV1p7czEU0Tw0WEA0hBropuc,8123
+flowcvcli/customization.py,sha256=Kz34TZnyzhVT9iN-neRf0I7UMdP4Q2QPOUBZceFvaRo,3869
+flowcvcli/markup.py,sha256=AFGb7YI-kZ_KQgM7qxVHFZ_24dwzv7qZ8SYh3fxrFGU,1785
+flowcvcli/personal.py,sha256=IjXGqOWt7K7ZVoqYZTupe5zhoeWo0La_YiDpQ9JXhJU,2755
+flowcvcli/photo.py,sha256=PERJtjhNKFgYftBsGNBEcokq8yZ0mmVkDiw9AVHLVcs,4088
+flowcvcli/resume.py,sha256=ZpI1gqwXE6y8WW0NVHm5l4cXj9fH2UTnxMqUOFXSg0Q,5564
+flowcvcli-0.2.0.dist-info/licenses/LICENSE,sha256=23m7cKsJg9PqqLZ0wK5RbcEGNAFbSchahsBJ8LGvX0g,1065
+flowcvcli-0.2.0.dist-info/METADATA,sha256=_yRE9G2QHWgy32PVmnSUjovBkYdsU2XGbRbJH0oU6js,9549
+flowcvcli-0.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+flowcvcli-0.2.0.dist-info/entry_points.txt,sha256=rS7BgaYFbAad6mzLcqK62k4kMgZ4UeurHj5wT_rgCDk,46
+flowcvcli-0.2.0.dist-info/top_level.txt,sha256=kvOYoW_loF42cvdHgkdKjyCQ-FiYDu1PLhAb40HkBaI,10
+flowcvcli-0.2.0.dist-info/RECORD,,

flowcvcli-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

flowcvcli-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+flowcv = flowcvcli.cli:main

flowcvcli-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 dannyota
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

flowcvcli-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+flowcvcli