# Simpromana

An Obsidian plugin for project and task management: a task flow graph, a
kanban board, a project side panel, and commands to keep `Projects`,
`Tasks`, and `Reference` notes wired together through frontmatter.

![Simpromana overview](docs/cover.png)

## Features

- **Flow view**: a graph of tasks and their relations (`blocked_by`,
  `continues`, `related`), grouped and laid out automatically.
- **Board view**: a kanban board (Todo/Doing/Review/Done) with
  drag-and-drop status changes and an optional project filter.
- **Project panel**: a side panel listing a project's tasks by status,
  with quick task creation.
- **Commands**: *New project*, *New task*, *New reference*, and *Archive
  current task*, each scaffolding the right frontmatter.
- Works alongside the core **Bases** plugin: project notes embed
  `Tasks.base` and `References.base` views for their own tasks and
  references. The *Setup bases* command creates whichever of the two
  is missing in the root folder; existing files are never overwritten.

## Installation

**Community plugins (recommended)**

Open the [Simpromana page](https://community.obsidian.md/plugins/simpromana)
on the Obsidian community site and install it from there, or:

1. Open Settings → Community plugins → Browse.
2. Search for *Simpromana*, install it, and enable it.

**BRAT (pre-releases)**

1. Install the [BRAT](https://github.com/TfTHacker/obsidian42-brat) community plugin.
2. In BRAT, *Add beta plugin*, and enter `christt105/obsidian-simpromana-plugin`.
3. Enable Simpromana under Settings → Community plugins.

**Manual**

1. Download `main.js`, `manifest.json`, and `styles.css` from the
   [latest release](https://github.com/christt105/obsidian-simpromana-plugin/releases/latest).
2. Copy them into `<vault>/.obsidian/plugins/simpromana/`.
3. Enable Simpromana under Settings → Community plugins.

Release assets carry GitHub build provenance attestations, so you can
check they were built from this repository with
`gh attestation verify main.js --repo christt105/obsidian-simpromana-plugin`.

The frontmatter fields and folder conventions are opinionated, built
around how I personally organize my own vault.

## Requirements

- Obsidian 1.13.0+.
- The core **Bases** plugin, if you want the `Tasks.base` /
  `References.base` views embedded in project notes.
- Recommended: the community plugin **[Base Board](https://community.obsidian.md/plugins/base-board)**,
  which the generated `Tasks.base` views use. Without it, those views
  fall back to a plain table.

## Note types

- **`project`** (`Projects/*.md`): one per ongoing effort, created via
  *New project*.
- **`task`** (`Tasks/Title - abc123.md`): created via *New task*, with a
  `project` frontmatter link back to its parent project.
- **`reference`** (`Reference/Title - abc123.md`): write-ups and audits,
  created via *New reference*, also linked back to a `project`.

Frontmatter property names and status values are configurable (see
Settings). The `type` values (`project`/`task`/`reference`) are fixed.

## Settings

Under Settings → Simpromana:

- The root folder and the `Projects` / `Tasks` / `Reference` / `Archive`
  subfolder names.
- The frontmatter property names: note type (`type`), project link
  (`project`), task and project status (`tstatus`, `pstatus`), `priority`,
  `milestone`, `epic`, `due_date`, and the keys new relations are written
  under (`blocked_by`, `continues`, `related`). The built-in relation
  aliases (`blocks`, `depends_on`, `continued_by`, `follows`,
  `related_to`, …) keep working. Renaming a property doesn't touch
  existing notes; rename it in them yourself, and re-run *Setup bases*
  after deleting the old `.base` files.
- The status values: task statuses in board column order (default
  `Todo, Doing, Review, Done`; the first is used for new tasks and the
  last counts as done), the status the *Archive current task* command
  sets (`Archive`), and the project statuses offered by *New project*.

## Privacy

Simpromana lists the notes in your vault to find projects, tasks, and
references by their `type` frontmatter, and edits their frontmatter
when you change a status or a relation. It makes no network requests;
nothing leaves your vault.

## Screenshots

![Task Flow View](./docs/task-flow.png)

![Task Flow Force View](./docs/task-flow-force.png)

![Project Board](./docs/project-board.png)

![Project Note](./docs/project-note.png)

![Task Note](./docs/task-note.png)

![Board View](./docs/board-view.png)

![Create Task Panel](./docs/create-task-panel.png)

## License

Licensed under [MIT](LICENSE) License.