Retrieves data from your Google or Apple calendar and creates some statistics that might be useful to you (or your boss ;) ) My stats are running live at https://mickekring.se/stats/time2/ (in Swedish)
Image above showing front end
I plan everything work related in my calendar and name the calendar events with prefixes like; 'ADM: Schedule' (ADM = Administration), 'WEB: Blogs' and so on. The script then groups all 'ADM:', 'WEB:' and other categories (hard coded in the script), calculates the time and divides it by the total time to get some percentages and other stuff that is useful to me. Simply put, it's a tool for me to make sure I spend my time well.
I also have a second calendar where I put my 8 hours a day so that my script can compare how much I should have worked, and how much I've really worked.
The Python script runs on a Raspberry Pi and fetches and updates statistics every 10 minutes, uploads the php-files to my web server via sftp.
I'm not a coder. I just like to create stuff. :)
- Python 3.x https://www.python.org/
- Bootstrap 5.x https://getbootstrap.com/
- Chart JS https://www.chartjs.org/
- Font Awesome https://fontawesome.com/
This script is sort of tailored to my needs, so if you'd like to run it, you'll have to change a couple of things. Mainly names of the categories you'd like to track and in that case, some conditions. Since I'm not a coder, I haven't (yet) been able to set all things you have to change as constant variables or lists, but I'll do my best to guide you.
WHAT YOU NEED
- A device that can run Python 3.x
- A web server with php support
- An sftp server (on your web server) that the script uses to upload files to your web server
- A public Google calendar (or Apple calendar)
SETUP
- Download all files to a folder of your choice
- Open credentials.yml and change sftp account information, paths - both local url (where you run the script) and remote (on your web server) and the url to your public calendar .ics file
- Open index.php and edit the title and headings that you want to display on your front end
- Upload index.php and style.css to your web server
- Open main.py and change the following:
- Line 36 | Locale
- Line 41 | Start date from when the script should start track
- Line 100-123 | Enter your own category prefixes and category names that you want to track
- Line 129 | Exclude calendar events like lunch and unknown
- Line 208 | The name of the calendar event in the second calendar (your work "official" work hours
- Line 307 | Modify the categories you want to track
- Line 623 | Modify the categories you want 7 week stats of and change/create lists names
- Line 789 - 813 | Change to your categories
- Line 827 - 840 | Change to your categories
- Line 889 - 912 | Change to your categories
- Line 632 - 640 | Change to your categories
- Line 1027 | Modify how often you want the main loop to run in seconds
- I may have missed a thing or two... sorry in advance...
INSTALL PYTHON MODULES
- iCalevents - pip3 install icalevents
- Pytz - pip3 install pytz
- Paramiko - pip3 install paramiko
- YAML - pip3 install pyyaml
- TinyDB - pip3 install tinydb
- Datetime - pip3 install datetime
- Pandas - pip3 install pandas
RUN
- Run main.py
- 1.0 Renamed some files and got rid of a lot of bloat.
- 0.6.1 Added download link for JSON database on front end generated by calstats.py
- 0.6 Added uploading of the json database file to the web server and fixed a bug that occurs when there is zero worked total time (e g when on vacation) which caused zero division.
- 0.5 Added dates for x-axis on the charts for the 7 weeks. Minor clean up of code.
- 0.4 Added graph for hours worked, last 7 weeks.
- 0.2 Initial upload. Percentages per category since a date you choose. Percentages per category, last 7 weeks.
The calendar import function in the script is based on jeinarsson work https://gist.github.com/jeinarsson/989329deb6906cae49f6e9f979c46ae7