strombringer / timesheet

Simple Docker container that outputs the Work From Home percentage for each timesheet pdf in a folder.

Timesheet analysis for Work from Home percentage

Simple Docker container that outputs the Work From Home percentage for each timesheet pdf in a folder.

How to use it

Run Docker container from Dockerhub

Run the docker container from within the folder that contains your timesheet pdfs:

Unix/MacOS:

docker run -t -v $(pwd):/data strombringer/timesheet

Windows:

docker run -t -v ${pwd}:/data strombringer/timesheet

The -t parameter is only needed for the highlighting of the current home office quota. Skip it, if you don't need that.

Parameters

Name	Python Shortcut	Environment Variable (Docker)	Default	Description
-quota	-q	TIMESHEET_QUOTA	70	Home Office quota
-dateformat	-d	TIMESHEET_DATEFORMAT	%d.%m.%Y	Date format of the dates in the first line of the input files (e.g. 01.07.2024
-format	-f	TIMESHEET_FORMAT	text | json	text = nicely formatted report table, json = all values of the report as a json document

Use the keys from Name or Python Shortcut as arguments when calling the Python script directly:

cat output.txt | python process_timesheet.py -f json -quota 50 | jq .

or environment variables when using the Docker container

docker run -t -v $(pwd)/data:/data -e TIMESHEET_QUOTA=50 timesheet

or an environment file (see config.env.tpl) with Docker

docker run -t -v $(pwd)/data:/data --env-file config.env timesheet

Contributing

Build Docker image locally

docker build -t timesheet:latest .

Debugging

If the output is not what you expect, run the included commands one by one.

Requirements

You need pdftotext, which you can install on Linux with

apt-get install poppler-utils

and MacOS with

brew install poppler

You also need the Python packages listed in requirements.txt

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -Ur requirements.txt

Option 1

Run the file input.pdf through pdftotext and write the result to output.txt

pdftotext -layout input.pdf output.txt

Pipe output.txt through the python script

cat output.txt | python process_timesheet.py

Option 2

Output pdftotext to stdout and pipe that directly through the Python script:

pdftotext -layout input.pdf - | python process_timesheet.py

Examples

Pretty-printed json with jq

cat output.txt | python process_timesheet.py -f json | jq .