ModE-Accounting-Module-Configuration.md

file	author	created	updated	tags
ModE-Accounting-Module-Configuration.md	Alisha Awen	2019-010-30	2020-007-16	Emacs, apps-tools, SysAdmin, HA-ModEmacs, MWM-how-to, how-to, README

Modular Emacs Accounting Module Install Guide

[Back To MAIN Modular Emacs README]

Introduction:

This module provides self customizeable Accounting & Double Entry Ledger Features to Harmonic Alchemy Modular Emacs...

I am currently experimenting with this. Looking into using hledger-mode etc. Initially I am using this document as a log of my first attempts... When I am done, you will not only have a guide to follow, but you will also know the why and how behind my chosen path. This will be invaluable as it will..., should have ... by that time ... been tested to work on all nx platforms producing the least headaches.

You will see documented historical proof, (of the dragons being slain) right here within this guide... As a result you will have all needed info and gotchas recorded along side in-line using block quote message boxes... (for your easy reference)

"TahMe!!" (shouting)
Here's to our pirate accountant...,
Haul Away... Haul Away...
His plain text ledgers arrre cuttin-down Quicken Rues,
Haul away... Haul Away...

No... more... Cyber Snatch Rules,
Haul Away... Haul Away...
Well "Stacked" bounties, gladly waging our labour,
Haul Away... Freedom Bound!

Deep... Adventure... We do sail,
Haul Away... Haul Away!...
On a plain text ship that's Freedom Bound,
A ship called The Haskell Ledger! Arrrrr!"_

(lol my rhyme scheme got wak - you figure out the rhythm... I think it's a slow hornpipe for hauling up the main and mizzen on your Emacs boat. I will improve it later... %^)

Refs:

• PTA.org Dedicated to Plain Text Accounting
• HLedger Github Project
• Discussion Thread on Hacker News
• Emacs HLedger Mode GitHub Project
• Haskell stack - This is HLedger's recommended tool set to use to build and install HLedger from source. It is a comprehensive development environment for Haskell which includes: Stack itself, (a project builder for multi-package Haskell projects) GHC, (the official compiler and interpreter for Haskell programs), Haddock, (a documentation generator for Haskell packages), and Stackage, (a curated repository of thousands of packages installed on demand).
• GHC - Glasgow Haskell Compiler - GHC is a state-of-the-art, open source, compiler and interactive environment for the functional language Haskell.
• Haskell cabal - CABAL: (Common Architecture for Building Applications and Libraries)

Install HLedger:

Intro:

My initial research suggests trying HLedger (based on Haskell) first instead of the older Ledger project (based on C++)... I have decided to clone the project and build the HLedger source from my local private branch... Dependencies for building include installing stack or cabal... You need to get those project dependencies installed first. Looks like stack is the preferred method...

After that is done, you will be git cloning the HLedger Project to build it via stack... Official HLedger build from git-repo Instructions are Here

Install HLedger Project Dependencies:

Before cloning HLedger, first install necessary Haskell build tools... You can build HLedger using either stack or cabal... I choose to use Stack as this is what the HLedger docs recommend as the best way.

Follow this link to: Install Haskell IDE, All Platforms

Clone HLedger Project from GitHub:

Go to the directory where you keep your local builds and then run the following:

    git clone https://github.com/simonmichael/hledger
    cd hledger
    stack install

Wait, wait, wait... while it builds everything for the first time!!! Nice that you don't have to do much configuration... Hopefully... %^) When all of this is done you will have hledger installed in: $HOME/.local/bin/hledger.

Now to setup hledger-mode in Emacs

Configure hledger-mode:

You created the file: ~/.emacs.d/lisp/modules/15-Accounting-pkg-conf.el... Visit that file to see the configuration.

I set the following key bindings:

    (global-set-key (kbd "C-c e") 'hledger-jentry)
    (global-set-key (kbd "C-c j") 'hledger-run-command)

Once you are in a report buffer after executing a command with hledger-run-command, press h to see the list of reports that you can have a look at. Press s in the overall report to see the meaning of the personal finance ratios for your report.