Tcelfer

[t]cel-fer:

A fun way to keep track of simple summaries of your months.

generated_report

Requirements

Ruby 2.3.0+ (Tested with 2.6.0 mostly)
Sqlite3

Installation

Add this line to your application's Gemfile:

gem 'tcelfer', '~> 1.0'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tcelfer

Setup

# Example configuration
export TCELFER_CONF=~/.config/tcelfer/my_conf.yml
cp config/tcelfer.example.yml ${TCELFER_CONF}
# Initialize the database
$ tcelfer db init

Usage

# TODO: Find a better way to do this
# export TCELFER_SQLITE_PATH TCELFER_CONF from above
# Record your day
$ tcelfer day [-d 2018-12-31]

# Reflect on your month
$ tcelfer report [-y|--year=)YEAR] -m|--month=MON [--legend]

record_day recorded_day

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, and push git commits and tags

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tcelfer-me/tcelfer