https://github.com/sdqali/microjournal

Simple Git powered journal
https://github.com/sdqali/microjournal

Last synced: 2 months ago
JSON representation

Simple Git powered journal

• Host: GitHub
• URL: https://github.com/sdqali/microjournal
• Owner: sdqali
• Created: 2012-06-19T14:10:01.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2016-06-29T04:09:53.000Z (about 8 years ago)
• Last Synced: 2024-04-14T14:17:07.003Z (3 months ago)
• Language: Python
• Homepage: http://blog.sdqali.in/blog/2012/06/25/micro-journal-simple-git-backed-python/
• Size: 5.86 KB
• Stars: 8
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Lists

• awesome-git-powered - Microjournal

README

        
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

```shell

git clone https://github.com/sdqali/microjournal.git

```

2. Once you have cloned the repo add the bin directory to your

$PATH. This can be done by adding

```shell

export PATH=$PATH:/bin

```

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

Setting up a journal

-------------------

1. Run

```shell

mkdir foobar

```

```shell

cd foobar

```

```shell

microjournal init [email protected]:sdqali/foobar.git

```

This will create the following directory structure


foobar

  |- entries

  |- .git



In addition, it will add `[email protected]:sdqli/foobar.git` as a remote for the Git

repo created.

Adding entries

--------------

1. Run

```shell

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

```shell

microjournal safekeep

```

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