https://github.com/newswangerd/digital_carrot
https://github.com/newswangerd/digital_carrot
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/newswangerd/digital_carrot
- Owner: newswangerd
- Created: 2025-02-03T21:57:36.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-09T15:27:10.000Z (3 months ago)
- Last Synced: 2025-02-14T07:51:51.304Z (3 months ago)
- Language: Python
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Digital Carrot
This project aims to help you achieve your goals by hanging a digital carrot in front of you for motivation!
This program will block you from accessing a set of user configurable websites on your computer until you have
met a certain set of goals for the day. These goals can be anything you want, as long as it is enforceable by
a computer script.
## Requirements
Currently only MacOS is supported. Linux support is planned. Windows will probably never be supported.
## Installation
Clone this repository, cd to it and run `pip install -e .`
## How it Works
The first step is to create a new project using `digital-carrot init`. This will lay down a directory with
the following files:
- `config.json`
- `sample_script.py`
The `config.json` file looks like this:
```json
{
"blocked_websites": [
"example.com"
],
"conditions": {
"example_condition": {
"script": "sample_script.py",
"args": ["arg1", "arg2"],
"require_on": ["mon", "tue", "wed", "thu", "fri", "sat", "sun"],
"pause_condition": {
"pause_args": ["pause"],
"max_pause_days": 10
}
}
},
"disable_method": "password"
}
```
You'll use this file to set up the restrictions you want to place on yourself!
### Setting your Conditions
This is where you provide your unlock scripts. Lets say you want to walk 10,000 steps per
day. You can create a script like the one bellow that checks an API for the smart watch of your choice:
```python
#!/usr/bin/python3
import requests
import sys
steps = requests.get("https://my_api.example.com").json()["steps"]
required_steps = int(sys.argv[1])
if steps >= required_steps:
print("You got all your steps!")
exit(0)
else:
exit(2)
exit(0)
```
Save this file to `check_steps.py` and then add the following to your conditions:
```json
{
"conditions": {
"complete_steps": {
"script": "check_steps.py",
"args": ["10000"],
"require_on": ["mon", "tue", "wed", "thu", "fri", "sat", "sun"],
"pause_condition": {
"pause_args": ["20000"],
"max_pause_days": 10
}
}
}
}
```
With this configuration, the system will unblock once `check_steps.py` returns a success.
Additionally, if you want to take a longer break you can run `digital-carrot pause complete_steps 4`.
This will rquire that you hit 20000 steps to unlock (configured in `pause_args`), but will let
you pause for up to 10 days.
### Starting the Blocker
To start the blocker run `sudo digital-carrot start config.json`. This will load the blocker with the configurations
you just created. You will be prompted for a password. *MAKE SURE YOU DON'T FORGET IT!* The only way to stop
the system will be to provide this password.
Once you have accomplished your goals for the day simply run `sudo digital-carrot unblock`. The system will check
if you met your goals. If you have, it will stay unblocked until 2am on the next day.
*WARNING*
Once you start digital carrot, you cannot edit anything about your configuration unless you disable it completely.
This program is intentionally very tamper resistant! If you lose your password, it will be very hard for you to
stop the system from running.
### Addition Additional Restrictions
New websites and conditions can be added by adding them to your `config.json` and then running
`digital-carrot update config.json`. NOTE: You can only add restrictions this way. Once your
config is set up, there's no going back!
### What if one of my scripts breaks?
There is a reason we use exit code 2 to indicate failure, instead of exit code 1. If one of your scripts
ever runs into an unexpected error, you can run `digital carrot purge` and it will remove any conditions
that are broken or have never returned a success from your configuration.
## config.json
The config file takes the following settings:
- `blocked_websites`: a list of websites that you want to block.
- `conditions`: the conditions that need to be met to unblock access to your websites.
- `disable_method`: your escape hatch for disabling the blocker complete. Right now
only `password` is supported, but more will be coming.