Skip to content

Latest commit

 

History

History
100 lines (84 loc) · 4.24 KB

README.md

File metadata and controls

100 lines (84 loc) · 4.24 KB
Raw

WakaTime Updates Tracker

This repository stores and compiles WakaTime Languages and Projects data from emails and saves the stats ✨
Explore the docs »
Report Bug . Request Feature

Table of Contents

About The Project

There are a lot of WakaTime stats tracker for Github Readme available online, however, I didn't find one that uses email gist sent by WakaTime to commulate all the stats.

Here's why:

  • WakaTime stats for months, years...
  • Free account supported 😄

Built With

This project was built with python3 and is powered by github actions for cron job tasks.

Getting Started

To get up and running with this project on your local machine follow these simple steps.

Prerequisites

Here's a list of things you'll need to have prior to generating the stats

  • Gmail account with all WakaTime report, refer to screenshot in Installation Section
  • Label of wakatime added to all the report emails
  • Python v3+

To download python3+ visit https://www.python.org/downloads/

Installation

  1. Clone the repo
$ git clone https://github.com/avisionx/wakatime-updates-tracker.git
  1. Install python packages
$ pip install -r requirements.txt
  1. Setup an email id on gmail with all the wakatime update emails they look like as shown below, and add label of wakatime to all of them. WakaTimeEmailSS
  2. Create a .env file for local or Github Secrets
EMAIL_ID = your_gmail_email_id@gmail.com
EMAIL_PASSWORD = your_emails_password
  1. Run the main.py file
$ python main.py
  1. Can use Raw CDN from Github to host this like so
https://raw.githubusercontent.com/avisionx/wakatime-updates-tracker/master/data.json

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Avi Garg - https://avisionx.net/ - hello@avisionx.net

Project Link: https://github.com/avisionx/wakatime-updates-tracker