chore: v2.4.1 documentation and version polish#51
Conversation
- Bump version to 2.4.1 in setup.py and cura_frame/__init__.py - CITATION.cff: add version field (2.4.1) to both top-level and preferred-citation; add version to preferred-citation - README: remove stale February 2025 update banner - README: correct Render.com deployment section — SQLite+persistent-disk was wrong; actual deploy uses managed PostgreSQL via DATABASE_URL; add JWT_SECRET prerequisite - README: update BibTeX citation keys, years (2025→2026), and version (0.1.0→2.4.1) - README: remove redundant second License section (full section already present earlier)" Agent-Logs-Url: https://github.com/dfeen87/CuraFrame/sessions/cb487ba4-29af-46f8-bcb7-f6a2fbb2e2f7 Co-authored-by: dfeen87 <158860247+dfeen87@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR polishes the v2.4.1 release by aligning version metadata and correcting documentation (notably Render deployment instructions and citation blocks) to match the repository’s actual configuration.
Changes:
- Bumped package version to
2.4.1insetup.pyandcura_frame/__init__.py. - Updated
CITATION.cffto includeversion: "2.4.1"(top-level and preferred citation). - Corrected README deployment docs for Render (managed Postgres +
DATABASE_URL,JWT_SECRETprerequisite), refreshed citations/year, and removed stale/duplicate sections.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| setup.py | Updates distribution version to 2.4.1. |
| cura_frame/init.py | Aligns library __version__ with the 2.4.1 release. |
| CITATION.cff | Adds explicit 2.4.1 version metadata for citation tooling. |
| README.md | Fixes Render deployment description, updates citation blocks/year, removes stale banner and duplicate License section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - A **managed PostgreSQL database** (`curaframe-db`) on Render's free database plan (PostgreSQL 18). | ||
| - A **web service** (`curaframe-web`) on the **Starter plan**, with `DATABASE_URL` injected automatically from the managed database. | ||
| - `CURAFRAME_SECURE_COOKIES=1` — marks session cookies as `Secure` (required for HTTPS on Render). | ||
| - A second **web service** (`curaframe-console`) running the Streamlit console on the free plan (no database needed). | ||
| - A second **web service** (`curaframe-console`) running the Streamlit console on the free plan, also connected to the database. |
There was a problem hiding this comment.
README now states Render deploy uses a managed PostgreSQL DB via DATABASE_URL, but the FastAPI app’s SQL uses SQLite-style ? parameter placeholders (e.g., INSERT ... VALUES (?, ...)). Psycopg expects %s/pyformat placeholders, so the app will fail at runtime when pointed at Postgres. Either update the query/DB helper layer to use the correct placeholder style for Postgres (or translate ?→%s when is_postgres), or adjust the deployment instructions/render.yaml to match the actually supported DB backend.
| @software{curaframe2026, | ||
| title = {CuraFrame: Constraint-Driven Therapeutic Design Reasoning}, | ||
| author = {Feeney, Don Michael}, | ||
| year = {2025}, | ||
| version = {0.1.0}, | ||
| year = {2026}, | ||
| version = {2.4.1}, |
There was a problem hiding this comment.
Citation metadata is inconsistent between CITATION.cff (family name includes "Feeney Jr.") and this BibTeX entry (author is "Feeney, Don Michael"). If the intended family name includes the suffix, consider updating the BibTeX author field to match so automated citation tooling doesn’t treat these as different authors.
Second-pass hardening pass to bring documentation accuracy, version alignment, and deployment instructions to commercial-ready quality for the v2.4.1 release.
Version bumps
setup.pyandcura_frame/__init__.py:0.2.0→2.4.1CITATION.cff: addedversion: "2.4.1"at top level and inpreferred-citationREADME corrections
CURAFRAME_DB=/data/curaframe.db). Actualrender.yamlprovisions a managed PostgreSQL 18 database and injectsDATABASE_URL. Corrected all references and added the missingJWT_SECRETprerequisite (required at startup byconfig.py, silently breaks the app if absent).year(2025→2026), andversion(0.1.0→2.4.1) to match copyright year and this release.📣 Update — February 2025) removed — no informational value for new readers.## Licensesection near the bottom removed — full section already present earlier in the document.