easy_time_tracker package

Subpackages

Submodules

easy_time_tracker.cli module

easy_time_tracker CLI

easy_time_tracker.cli.cli() → None[source]

Function to run the command line :rtype: None :returns: None

easy_time_tracker.constants module

Constants for easy_time_tracker

easy_time_tracker.easy_time_tracker module

easy_time_tracker

class easy_time_tracker.easy_time_tracker.EasyTimeTracker[source]

Bases: object

Class to create records, and end records, data directories are not created automatically on purpose.

Variables

  • EASY_TIME_TRACKER_CURRENT_RECORD – Calculated using users home directory, you can also set an environmental variable to save data were you want.

  • EASY_TIME_TRACKER_COMPLETED_RECORDS – Calculated using users home directory, you can also set an environmental variable to save data were you want.

EASY_TIME_TRACKER_COMPLETED_RECORDS = '/home/docs/easy-time-tracker-data/completed_records.json'
EASY_TIME_TRACKER_CURRENT_RECORD = '/home/docs/easy-time-tracker-data/current_record.json'
EASY_TIME_TRACKER_PROJECT_LIST = '/home/docs/easy-time-tracker-data/projects.txt'
end_time_record(comments: Optional[str] = None) → None[source]

Method to end a time record

Parameters

comments (Optional[str] default: None) – Any comments about the time you want to add

Return type

None

Returns

It ends time records at writes archive

Raises

FileNotFoundError – If a current record is not ongoing

start_time_record(description: str, people: list, project: Optional[str] = None) → None[source]

Method to create a record and write the data

Parameters

  • description (String) – The description of the time being recorded

  • people (List) – A list of people during the time

Return type

None

Returns

None

write_completed_records_to_excel(path: str) → None[source]

Method to export completed records as Excel file

Parameters

path (String) – The path to output file to

Return type

None

Returns

It writes Excel files

Raises

FileNotFoundError – If completed records ins not found

easy_time_tracker.gui module

A simple GUI

class easy_time_tracker.gui.Gui(master: Optional[Tk] = None)[source]

Bases: Frame

Class to run the Easy Time Tracker GUI

Parameters

master (tk.Tk) – The tkinter object

Return type

None

Returns

None

static clear_text_box(text_box: Entry)[source]

Static Method to clear a text box

Parameters

text_box (tk.Entry) – The text box to clear

Return type

None

Returns

None

create_comments_text_box() → None[source]

Method to create the comments text box and label for it

Return type

None

Returns

None

create_description_text_box() → None[source]

Method to create the description text box and label for it

Return type

None

Returns

None

create_people_text_box() → None[source]

Method to create the people text box and label for it

Return type

None

Returns

None

create_project_dropdown(projects: list) → None[source]

Method to create the project dropdown box

Parameters

projects (list) – The list of projects

Return type

None

Returns

None

create_start_button() → None[source]

Method to create the start button and hide the stop group

Return type

None

Returns

None

create_stop_button() → None[source]

Method to create the stop button

Return type

None

Returns

None

static hide(group: list) → None[source]

Static Method to hide a list of widgets

Return type

None

Returns

None

start_button_callback() → None[source]

Method for the callback of a start button click

Return type

None

Returns

None

start_group = []
stop_button_callback() → None[source]

Method for the callback of a stop button click

Return type

None

Returns

None

stop_group = []
static unhide(group: list) → None[source]

Static Method to unhide a list of widgets

Return type

None

Returns

None

easy_time_tracker.gui.ett_gui() → None[source]

Function to start the GUI

Return type

None

Returns

None

easy_time_tracker.version module

Version info

Module contents

init for easy_time_tracker