Skip to content

contrick64/daily-diary

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Daily Journal

daily.py is a command-line utility for managing a daily journal. It provides several functionalities such as creating a new entry, adding to an existing entry, wrapping text, and opening the journal in an editor.

Installation

daily-diary currently requires python3.10 or higher. The reasoning for this is silly, and should change, I think. I'll get to it eventually.

I recommend installing with pipx. You can run the same command with pip instead.

pipx install daily-diary

Currently there is no way to configure the location of your diary, it will go in ~/notes/daily/.

Usage

You can use the daily.py script from the command line as follows:

python daily.py [command] [options]

The available commands are:

  • write: Write an entry to today's file, create it if not exists.
  • add: Add an entry inline. Requires the -m/--mood and -e/--entry options.
  • edit: Edit today's entry without adding any headers.

for any command:

  • -w/--wrap-file: Wrap the entire contents of today's file after editing.

For the add command, these are required:

  • -m/--mood: The mood character and word(s) to be included, like + motivated joyous
  • -e/--entry: The text to be entered into your diary.

Contributing

To install the dev branch, I recommend using pip install -e . in the repository dir.

This is the first repository I am creating with the intent of inviting contributions and turning into a proper package. Please feel free to suggest features, make PRs, or report bugs as you see fit.

I will also accept suggestions on how best to accept suggestions...

License

This project is licensed under the GPLv3 License.