Roadmap

[shunichironomura]

Roadmap

This issue is for brainstorming (not promising) on Capsula's roadmap.

Capsula has three core functions:

1. Context capture
2. Execution monitoring
3. Context reproduction

Context capture

• Python version
• Platform
• Python dependencies and their versions
• Output of a command #131
• Environment variables (that are explicitly specified)
• Git commit hash
• Git diff (if the dirty state is allowed. as a patch file)
• Hash of specified files
• Add .gitignore file in the vault subdirectory #152
• Allow to add a custom context item

Execution monitoring

General

• Execution start time, end time, and duration
• Working directory
• Custom callback (e.g., Slack notification on completion) #126
• Hash of output files

CLI

• Comment line arguments
• stdout and stderr
• Exit code

Decorator

• Python function name, file, and line number
• Python function arguments
• Custom key-value pairs (added inside the function to run) #127
• Raised exception
• Logging output
• Custom logging insertion using module-level function

Context reproduction

• Git checkout and patch apply #130
• Checks hash of specified files #128

Miscellaneous

• capsula init command to generate capsula.toml file
• capsula --version command #109
• Add older Python versions #15
• make it pipx installable #28
• capsula hash command to get the hash of a file #129

[shunichironomura]

Closing this issue as the remained tasks are either turned into a sub-issue for future reference, or should be ignored.

As for the ignored tasks:

• Logging output and custom logging insertion: Should be taken care of by other libraries. capsula.record can do some of what they want?
• capsula init We should instead minimize the required configuration, i.e., works out of the box.