dragotin / re Goto Github PK

Little helper script to write weekly work reports in the RED-AMBER-GREEN format.

License: GNU General Public License v3.0

Perl 94.50% Makefile 5.50%

re's Introduction

re - Work Reports Made Easy

re is your tool to organize weekly work reports which employees often have to write to their management. The reports are kept in normal text files and are stored in a simple file tree at a defined place on the file system.

How to Use

re is a command line utility. If you type 're' on the commandline, it opens $EDITOR with the work report of the current week. Using command line options, re opens other weeks for you.

The format of the reports you want to write is completely up to you, yet re has a default that uses the [RED] - [AMBER] - [GREEN] format, that seems to be widely used in IT industry. Items posted under [RED] are critical and require help from your manager, items under [AMBER] are not running well, but are kept under control by you and [GREEN] is things you did successfully.

Configuration

To configure re, copy the file rerc.template from the source directory to $HOME/.rerc and edit the data within accordingly. You should find sufficient documentation of the available options in the template file.

Be careful with the syntax, the rerc must contain valid perl hash code, ie. value => key, separated by colons.

In the rerc there is a template for new report files. The strings SENDER, WEEK and YEAR are replaced automatically with the according values.

Synchronization

To make re useful if you work with more than one computer, ie. an office desktop computer and a laptop, re can use an ownCloud server to synchronize the work reports. It just syncs before and after an edit of the work report automatically. That way you always edit the most recent version, and save your edit immediately on the ownCloud.

For that, the ownCloud sync client package must be installed. re uses a tool called owncloudcmd that comes with the ownCloud sync client.

Check the configuration template for the ownCloud sync options.

Attention: To not to have to deal with credentials, re calls owncloudcmd with option -n. That tells the tool to read the ownCloud credentials from .netrc. You have to configure it there.

Options

re can be influenced by the following command line options:

-l opens the report from last week.
-w <number> opens the week number of the current year.
-s opens the work report in preferred email client for sending.
-o syncs the weekly report to ownCloud before and after editing.

Contribute

If you want to contribute to re, just fork it here and post pull requests. For bug reports, please use the github issue tracker.

Have fun and make your manager happy!

re's People

Contributors

Stargazers

Watchers

Forkers

danimo jnweiger allisonrandal dpapac

re's Issues

Debian build instructions

sudo apt install perl # probably already installed
cpan install # answer question with "sudo"
cpan install Date::Calc
cpan install IPC::Run
git clone https://github.com/dragotin/re
cd re
./re # should work now

More Output Options

So far re has only the output format text based mails.

It would be good to have more output options, such as PDF or html.

Can't locate IPC/Run.pm on MAC

I have downloaded and installed re, but when I try to run it on MAC I got the error:

Can't locate IPC/Run.pm in @INC (you may need to install the IPC::Run module) (@INC contains: /Library/Perl/5.30/darwin-thread-multi-2level /Library/Perl/5.30 /Network/Library/Perl/5.30/darwin-thread-multi-2level /Network/Library/Perl/5.30 /Library/Perl/Updates/5.30.3 /System/Library/Perl/5.30/darwin-thread-multi-2level /System/Library/Perl/5.30 /System/Library/Perl/Extras/5.30/darwin-thread-multi-2level /System/Library/Perl/Extras/5.30) at ./re line 36.

BEGIN failed--compilation aborted at ./re line 36.

Issues with escaping special chars in the body

For example something like Lucy's dog is escaped terribly wrong when the body is inserted into the MUA with re -s

Attributes for Sections

It would be good to have a way to define the sections in the config, and assign attributes to the section tempates to influence how re treats the sections.

Possible attributes so far:

persistent - copy the entries underneath this section to the new week
don't send: do not include this section in the mail when calling re -s

Both switches would be helpful for todo lists.

Make release

issue release number
assign license

I'd really like to package it :)

re does not create the directory structure for reports

On first run:

re
Failed to open report file to write: No such file or directory

An strace revels it's trying to open the directory ~/weekly_reports/2018
re aught to mkdir -p this directory structure.

- FIXME: propagate_section('UPCOMING','/...') not impl.

FIXME: propagate_section('UPCOMING','/home/carlos/weekly_reports/2021/cw_17.txt') not impl.
FIXME: propagate_section('ATTENTION','/home/carlos/weekly_reports/2021/cw_17.txt') not impl.

my .rerc is:

carlos@snoopy4:~$ more .rerc
# copy this to your home directory into file .rerc and customize 
# as needed. 
# Don't forget the commas at end of lines end and leave TEMPLATE at the end.
#
SENDER => "Carlos Damken",
GITUSER => "cdamken",
GITPROJ => "cdamken",
RE_BASE => "/home/carlos/weekly_reports",
BULLET => '-',
ADD_BLANK_LINES => 0,
PROPAGATE => 'UPCOMING,ATTENTION',
SECTION_MARKER => '[',
DEFAULT_SECTION => 'GREEN',

TEMPLATE =><<ENDL

Work report SENDER cw WEEK/YEAR

[1] Critical

[2] Severely restricting

[3] Minor impact

[4] No loss of service or other

[5] Additional

[6] To be Done

---

Best regards,
Carlos Damken

ENDL

Is there a new releas?

Unable to view work report from previous year

re -l
Better make holiday than writing work reports!

Tried to check what I was working on last week, but re can't cross year boundaries!