MacTech Conference 2011 Preso
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
invoices
ledgers
notes
scripts
worklogs
README.html
README.markdown
README.pdf
Zack Williams.vcf
mtc2011_logo.png
mtc2011_vcs_preso_demo.mov
mtc2011_version_control_presentation.pdf

README.markdown

Managing Data with Version Control

This repo goes along with a presentation given at MacTech Conference 2011

MacTech Conference 2011

Notes about my particular process

I create new files in "notes", which are transformed into the XML worklog syntax, which is stored in "worklogs". This syntax is used to create PDF invoices in "invoices" or ledger files in "ledgers".

I don't include the worklog parsing/ledger/pdf generation code itself because it's pretty ancient, in PHP, has a bunch of weird non-current library dependencies and does some really stupid things (for example, storing unix timestamps in the XML, rather than ISO-8601 dates).

The rest of the files in the repo were added after the fact (like this README which you are reading right now).

Tools

Automation Tools

Documentation Tools

  • Markdown

    • minimal markup language, widely implemented
    • One example: MultiMarkdown
  • Pandoc

    • Documentation format conversion swiss army knife
    • Will convert Markdown to HTML, ePub, PDF, etc.

Accounting Tools

  • Ledger
    • Ledger is a CLI accounting tool
    • Multiple implementations
    • The 3.x beta branch off of github is preferred over the older 2.6.x version in MacPorts

Scripts

Note that these are pulled straight from my code, and won't work without fairly serious modifications - they often will need other utilities installed. Use this as a starting point

scripts/docgen

This is the documentation generation script that I use to convert markdown files into different formats - for example, turning this README into a nicely formatted PDF and HTML docs that are also in the repo.

It's dependent on pandoc, imagemagick, pdfcrush, advpng and a few other XML specific tools like jing.

See the test subfolder for examples - all the files inside were created from testfile.mkd

scripts/mailsend.scpt

A very simple Applescript that will send an email with specified subject/sender/attachments. I run this with a bash script that calls rake. The code as written below needs help to be functional in your environment.

bash script:

#!/usr/bin/env rake
RAKECMD="rake -f ~/tools/worklog.rake"
${RAKECMD} "${1}" target="${2}"

rakefile - at ~/tools/worklog.rake in my environment

# paths
tool_path = "~/tools"

# binaries
$osascript_bin = "/usr/bin/osascript"

# scripts
$mailsend_scpt = tool_path + "/worklog/mailsend.scpt"

# set the target variable if it's a valid file
$target = nil
if !ENV["target"].nil? && File.file?(ENV["target"])
    $target = ENV["target"];
end

# mailinvoice
desc "Create an email message with attachment in Mail.app" 
task :mailinvoice => [ :worklogs, :ledgers ] do
    if $target
        note_date = `date +"%Y-%m-%d"`
        filepath = File.expand_path($target)
        name = customer_name()
        email = customer_email()
        sh "#{$osascript_bin} #{$mailsend_scpt} 'Invoice for #{note_date}' 'Please see the enclosed invoice\n\n' #{name} #{email} #{filepath}"
    end
end

def customer_name()
    return "customer"
end

def customer_email()
    return "user@host.net"
end