kfickel/streamd
1
0
Fork 0
Code Issues 10 Pull requests 3 Projects 1 Wiki Activity Actions

refactor!: rename package from streamer to streamd

Browse source 
- Rename src/streamer/ to src/streamd/
- Update all internal imports
- Update pyproject.toml project name and entry point
- Update README branding (Streamer -> Strea.md)
- Switch from pyright to basedpyright
- Bump requires-python to >=3.13
This commit is contained in:
Konstantin Fickel 2026-02-15 17:30:31 +01:00
parent 49cd9bcfa0
commit af2debc19b
Signed by: kfickel
GPG key ID: A793722F9933C1A5
23 changed files with 48 additions and 789 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,6 +1,6 @@
# streamer
# strea.md
Streamer is a personal knowledge management and time-tracking CLI tool. It organizes time-ordered markdown files using `@tag` annotations, letting you manage tasks, track time, and query your notes from the terminal.
Strea.md is a personal knowledge management and time-tracking CLI tool. It organizes time-ordered markdown files using `@tag` annotations, letting you manage tasks, track time, and query your notes from the terminal.
## Core Concepts
@ -12,23 +12,23 @@ Streamer is a personal knowledge management and time-tracking CLI tool. It organ
Markdown files are named with a timestamp: `YYYYMMDD-HHMMSS [markers].md`
For example: `20260131-210000 Task Streamer.md`
For example: `20260131-210000 Task Streamd.md`
Within files, `@`-prefixed markers at the beginning of paragraphs or headings define how a shard is categorized.
## Commands
- `streamer` / `streamer new` — Create a new timestamped markdown entry, opening your editor
- `streamer todo` — Show all open tasks (shards with `@Task` markers)
- `streamer edit [number]` — Edit a stream file by index (most recent first)
- `streamer timesheet` — Generate time reports from `@Timesheet` markers
- `streamd` / `streamd new` — Create a new timestamped markdown entry, opening your editor
- `streamd todo` — Show all open tasks (shards with `@Task` markers)
- `streamd edit [number]` — Edit a stream file by index (most recent first)
- `streamd timesheet` — Generate time reports from `@Timesheet` markers
## Configuration
Streamer reads its configuration from `~/.config/streamer/config.yaml` (XDG standard). The main setting is `base_folder`, which points to the directory containing your stream files (defaults to the current working directory).
Streamd reads its configuration from `~/.config/streamd/config.yaml` (XDG standard). The main setting is `base_folder`, which points to the directory containing your stream files (defaults to the current working directory).
## Usage
Running `streamer` opens your editor to create a new entry. After saving, the file is renamed based on its timestamp and any markers found in the content.
Running `streamd` opens your editor to create a new entry. After saving, the file is renamed based on its timestamp and any markers found in the content.
Running `streamer todo` finds all shards marked as open tasks and displays them as rich-formatted panels in your terminal.
Running `streamd todo` finds all shards marked as open tasks and displays them as rich-formatted panels in your terminal.