Skip to content

ralph-groupscholar/groupscholar-mentor-note-atlas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Group Scholar Mentor Note Atlas

Mentor Note Atlas is a batch Emacs Lisp CLI that scans mentor session notes, extracts structured signals, and produces summary files for Group Scholar operations. It supports JSON/CSV exports, a markdown report, and optional Postgres sync for analytics.

Features

  • Parse Markdown mentor notes with YAML frontmatter.
  • Extract tags, mentor ownership, scholar IDs, and action items.
  • Export JSON or CSV datasets plus a Markdown summary report.
  • Optional Postgres sync using a dedicated schema.

Tech Stack

  • Emacs Lisp (batch CLI)
  • ERT for tests
  • PostgreSQL (optional sync)

Getting Started

Install dependencies

  • Emacs 30+
  • psql (for sync)

Example note format

---
scholar_id: GS-1001
mentor: Jasmine Patel
date: 2025-12-03
tags: outreach, financial-aid
---
Met to review FAFSA timeline and scholarship list.

- [ ] Send scholarship checklist
- [ ] Share draft budget template

Run the CLI

bin/gs-mentor-note-atlas --notes-dir notes --out-dir out --format json --report

Outputs:

  • out/mentor-note-atlas.json (or .csv)
  • out/report.md

Postgres sync

Set PG env vars (for production) and run:

export PGHOST=...
export PGPORT=...
export PGUSER=...
export PGPASSWORD=...
export PGDATABASE=...

bin/gs-mentor-note-atlas --notes-dir notes --out-dir out --format json --sync

To initialize the schema and seed data:

psql -v ON_ERROR_STOP=1 -f scripts/db_init.sql
psql -v ON_ERROR_STOP=1 -f scripts/db_seed.sql

Tests

scripts/run-tests.sh

Project Structure

  • src/gs-mentor-note-atlas.el: CLI implementation
  • bin/gs-mentor-note-atlas: shell wrapper
  • test/: ERT tests and fixtures
  • scripts/: DB init/seed + test runner
  • ralph-progress.md: iteration log

License

MIT

About

Emacs Lisp CLI for mentor note indexing, reporting, and Postgres sync.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors