/microjournal

Simple Git powered journal

Primary LanguagePython

MicroJournal

Microjournal is a simple, lightweight journal backed by Git. On its own, it does not do much. Instead of doing all the heavy lifting on it's own, it uses your default editor to add entries and uses Git to safe keep the entries. It does not do any kind of post processing on the entries. The expectation is that one would write the entries in plain text, but then you can use whatever format you want.

Installation

  1. Clone the MicroJournal repo
git clone https://github.com/sdqali/microjournal.git
  1. Once you have cloned the repo add the bin directory to your $PATH. This can be done by adding
export PATH=$PATH:<microjournal-repo-dir>/bin

to the end of the init file of your shell (~/.bashrc, ~/.zshrc)

Setting up a journal

  1. Run
mkdir foobar
cd foobar
microjournal init git@github.com:sdqali/foobar.git

This will create the following directory structure

foobar
  |- entries
  |- .git

In addition, it will add git@github.com:sdqli/foobar.git as a remote for the Git repo created.

Adding entries

  1. Run
microjournal jot

This will create the following directory structure

entries
  |- 2012
      |- 06
         |-

This will open the journal entry for today in your default editor (read from $EDITOR). MicroJournal will automatically add today's date and current date in to the entry.

Safekeeping

As mentioned above, MicroJournal does not do any magic of its own and hence Safekeeping just means a git push. To do this, run

microjournal safekeep

This would commit all the entries in the entries/ directory, and push to the remote.