sudiptob2/leet-easy

Get notification when leetcode publishes an easy daily challenge and grab your leetcoins.

LeetEasy

Desktop notification for easy daily challenges in leetcode.

We all know Leetcode's daily challenges are awesome 😎 However, sometimes these challenges are quite difficult for people who are just starting out problem-solving 🥲
This tool will send desktop notification when an Easy daily problem is published. This way you won't miss any opportunity to grab some easy Leetcoins 🪙 and stay motivated for the day 🔥

Requirements

• python >= 3.8

Installation

pip install leeteasy

run

Schedule leeteasy to send notification for easy leetcode problem at 14:30 (24 hours format time)

python -m leeteasy start 14:30 &

To add additional difficulty

python -m leeteasy start 14:30 --difficulty medium &

This will schedule leeteasy for Easy and Medium problem.

To stop leeteasy

python -m leeteasy stop

NOTE: By default leeteasy checks for scheduled task in every 1 hour/3600 seconds. So there might be 1-hour delay from the actual scheduled time while getting the notification. However, this can be controlled using --sleep_duration option.

Linux cronjob guide

Set a cronjob to automatically start leeteasy at system boot.

# open cronjob editor
crontab -e

# add the following line
@reboot python -m leeteasy start 14:30 &

Contributing

We are very happy to see you here. Before sending your pull requests, make sure that you read the whole workflow and the naming conventions mentioned in the contributing guidelines.

If you have any doubts regarding the contributing guidelines, please feel free to state it clearly in an issue. All the best!

leet-easy's Issues

Implement a stop command to kill leeteasy process

Query leetcode graphql API to get daily challenge.

Query leetcode graphql API at https://leetcode.com/graphql to fetch the daily challenge.

give a good installation guide line

how we can use this . give a good installation guide line

import pwd breaks leeteasy in windows

do not import import pwd when the platform is windows

Add a github action to publish leeteasy into pypi autometically

Implemet cli commands for scheduling leeteasy

implement more strict flake8 rules

Implement a github action to check unit tests

A GitHub action workflow to check the unit tests.

add a PR template

A simple and brief PR template will help the contributors and maintainers while developing LeetEasy. I would like to add a simple PR template as below

example template

# Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# Checklist:

- [ ] branch name follows the branch naming convention mentioned [here](https://github.com/sudiptob2/leet-easy/blob/main/docs/BRANCH-NAMING.md)
- [ ] commit messages to follow the format mentioned in [contributing.md](https://github.com/sudiptob2/leet-easy/blob/main/docs/CONTRIBUTING.md)
- [ ] I have tested my code using `bash .github/check.sh`
- [ ] I have performed a self-review of my code
- [ ] I have made corresponding changes to the documentation
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes

Add banner using canva

Add custom banner edited my me using canva
#hacktoberaccepted

please assign it to me with label

Handle missed notifications if the user's machine was powered on after the scheduled time had past

At the present situation to use leeteasy we schedule it using cronjob at the system startup like below, ref: docs

@reboot python -m leeteasy start 14:30 &  # we scheduled the notification at 14:30

Now, for example, the host machine was shut down at 14:30 and the user-powered has on his device at 15:00.
In this case he will miss the notification for the day as it's already past 14:30.

To handle this,
a check can be added before scheduling the Notifier. see here

if datetime.now().time() > validated_time:
    Notifier.notify()

we can get the validated time from the TimeValidator.validate(time) Ref: code

add unit tests for TimeValidator methods

need unit tests for TimeValidator

prepare for packaging

package leeteasy using docker

Update installation documentation

Add retry logic if can not connect to leetcode

In the current code, if leet-easy can not connect to leetcode API due to bad internet connectivity or any unknown issues, it does not retry.
Ref: here

I think a few retries would be better in such situations.

• max retry: 3 times
• Incremental interval ( first retry after 10 min, then 20 min, and then 30 min of sleep)

add a cool banner image in the readme

I am looking for a simple banner
some ref:

• canva template. This template might be a ref point, but you have to use relevant props, text, etc. Also color combination must be chosen while keeping leetcode in mind.
• Another repo chkware their banner is also pretty simple but effective

Implement a command line option to add extra diffuculty of leetcode problem

By default, leeteasy will send a notification when an easy problem is published. However, I want to implement a command line option ( for ex: --difficulty=Medium) which will enable user to add additional difficulty

fix broken unittests

unittest broken at tests/test_services/test_request_parser.py

return challenge objec from the parse method

Change default application name

As leeteasy dpends on notify-py for desktop notification, the default application title in notify-py is "Python Application (notify.py)"

Change this title and put default title as,
LeetEasy - leetcode notification

ref: leeteasy/services/notification_service.py

implement sleep_duration as an optional command line arg

fix: notification do not show when scheduled as cronjob in linux

Leeteasy uses notify-send for notification which do not work if leeteasy is started by a cron job.
ref : 1 2

A Logo/icon is required

To show an icon in the notification badge, we need a logo.
Keep the following concept/keywords while brainstorming for the icon 🙏

• leetcoins
• leetcode logo
• easy problem
• notification

I see a lot of people are interested in this issue. If you want to work on this issue, make a PR with your design. Hopefully, I will merge the best one.