pb866 / kimai.jl Goto Github PK

• implement CD/CI through github actions
• use Documenter.jl
• Define a workflow, set rules
  • Leave stable release branches open for backports?
  • support only current stable?
  • LTS version?
• Revisit branch protection rules
• Setup issue/PR templates

Ensure that if sick leave occurs within a defined vacation, it is counted as sick leave only and not as vacation.

• in a first step for v0.1, it is enough to add a description in the documentation, not to define sick and vacation days in the same period
• later, make sure sick days are counted before vacation days and no double counts occur
  • Update documentation

In addition to listed stats, show a graphical representation of the work hours balance.

Add a README. Decide, whether a wiki is necessary for more detailed explanations.

• Use a custom calendar from BusinessDays to define Vacation and SickLeave.
• Define a Set of vacation and sick days to overwrite the isholiday function from BusinessDays.
  • The Set should be redefined, when new leave days are added and automatically recognised by the isholiday function
• Refactor load_offdays using the new calendars for vacation and sick days.
• If the Xmas rule is applied, the full vacation and sick leave version with tables should be mandatory as it is necessary to know, whether Xmas and NYE are vacation or work days. Just an integer number does not provide enough information.
• This implementation will have the advantage of being able to extract for each day, whether it is a work day, weekend, vacation or holiday. A function should be written to return the type of day for a given Date.
  • This can be used to analyse previous periods, after kimai data has been loaded.

Find a workflow to auto-generate Documentation.

Either allow to restrict to a specified time period in the Kimai history (through the config.yaml or by kwargs) or introduce switches for compact and detailed output of the show function, possibly several levels of complexity (minimal out, full stats, additionally monthly stats).

When the vacation file does not exist or the vacation is set to an integer, the following error occurs due to save_tmp! not being called:

ERROR: KeyError: key "factor" not found

Implement control measures to check for unused or wrong kwargs. As a bonus warn of kwargs manipulating the same value, e.g. setting the balance directly or adding/subtracting to/from a balance.

Write a function save to save the current Kimai session and continue in the future. Start or continue a history of the balance, the vacation and sick leave.

• Save stop time of last Kimai entry to continue from there later (don't use stop date, may be corrupted from vacation)
• Ensure balance of new sessions that start with a fraction of a vacation are counted as overtime
• Ensure correct balances of work, vacation and sick days of current and previous balances (no double counts)
• Delete tmp data on save

Ensure break times are taken according to German law. Shorten work times, if breaks were not taken correctly. Ignore minimum length of 15 minutes for break times.

Use the first row of the sick leave DataFrame to summarise previous sick leave (total number of absence days, start/stop either of Kimai history or minimum span, in which sick leave occurred, remarks that labels sick history).

Allow the possibility to add comments in the input data files of vacation and sick leave by specifying a character, e.g. #, in CSV.read.

Use continuous development/integration for current project. Setup tool chain and a github actions script. Define workflows and rules how to commits.

• Make sure Christmas and New Year's Eve are counted as 0.5 workdays and adjust work balance
• Make sure vacation is properly counted
• Set behaviour with flag in the config.yaml or through kwargs
• Ensure correct warnings about vacation balance at the end of the year

• Reset counter for sick days at the beginning of new year
• Save history of sick days

Use unit tests to ensure quality of code.
Use code coverage to check coverage of tests.
Integrate with #17.

Ignore any kimai times, when reported on sick leave.

Add a function show to list the statistics of the Kimai time log:

• work balance as hh:mm and float in hours
• vacation taken/remaining
  • Mark hangover balance
• sick leave
• detailed and compressed stats
• comparable to kimbal

• Check, whether balance can be directly saved in params["Recover"] rather than "tmp"
• Or should "Recover" be preserved for the length of the session?
• Otherwise save "balance" and "deadline" in params["tmp"]["vacation"]
• Save vacation and sick leave data sets (and calendars?) in "Recover" for next session and restore at the beginning of a session
• Rename "tmp" to "Recover" or alike