dssg / dssg/triage

Log to a file from triage CLI

Open
#834 0 comments 0 reactions 0 assignees View on GitHub
trivial
Dominant language
Jupyter Notebook
Stars
201
Forks
62
PR merge metrics
No merged PRs in 30d

Description

In addition to logging to stdout/stderr when using the triage CLI, we should make it easier to ensure logs get captured to a file as well (although users could do this by redirecting the output, logging to a file would be good default behavior generally and providing some arguments to control it might be easier for users unfamiliar with bash).

A few features that seem like they would be useful:
- Log to a file in the project path by default, identified by the current timestamp (in addition to logging to the terminal)
- Allow specifying a log file name/path via a CLI argument
- Arguments to suppress logging to the terminal and/or file might be nice to have as well (e.g., `--quiet`)

Contributor guide

Open the contributing guide

Research direction

Start at the triage CLI entry point and inspect how it currently sends logs to stdout and stderr. Define the file-logging defaults and CLI controls requested in the issue, then verify that terminal and file output can be enabled or suppressed independently and that the selected path and timestamp behavior work as intended.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.