Skip to content

Commit 2ecdd5f

Browse files
committed
Improving the ReadMe
1 parent 23f0934 commit 2ecdd5f

File tree

3 files changed

+63
-1
lines changed

3 files changed

+63
-1
lines changed

README.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,64 @@
11
# Website-blocker-python
2-
A simple website blocker project implemented in Python, It can be used to block certain websites during working time to reduce distraction thus improving productivity
2+
3+
4+
## Intro
5+
Hi Guys 👋
6+
7+
This repo consist of a code of a simple website blocker project implemented in Python, It can be used to block certain websites during working time to reduce distraction thus improving productivity
8+
9+
10+
## The magic
11+
12+
The magic of this project lies on modifying the host file withing your
13+
computer that manages how you access the web
14+
15+
## Getting started
16+
17+
Well getting started with this project just clone the clone the repo
18+
and edit the host file location depending on the OS your using
19+
20+
```bash
21+
$ git clone https://github.com/Kalebu/Website-blocker-python
22+
$ cd Website-blocker-python
23+
Website-blocker-python $
24+
```
25+
26+
## Adding sites to block + Editing host files
27+
28+
Now open the *app.py* and the goto line 4 with variable *site_to_block*
29+
and you can add the sites you would like to block during work time
30+
![](sites_to_block.png)
31+
32+
Also when you go to the line no 12 and edit default host depending on
33+
Operating System you're using
34+
![](host_file_location.png)
35+
36+
37+
## One more thing
38+
39+
You would need to set up the starting working + ending working hours where you would like to be restricted accessing those websites
40+
41+
To do this go to line last line of our code and edit the hours where by
42+
43+
```python
44+
if __name__ == '__main__':
45+
block_websites(start_working_time, ending_working_time)
46+
```
47+
48+
## Congratulations
49+
50+
Well done you now have a fully functioning website blocker you have made yourself to improve the productivity in Python
51+
52+
## Issues
53+
54+
Incase you have any difficulties or issues while trying to run the script
55+
you can raise it on the issues
56+
57+
## Pull Requests
58+
59+
If you have something to add I welcome pull requests on improvement , you're helpful contribution will be merged as soon as possible
60+
61+
62+
## Give it a Star ✴️
63+
64+
If you find this repo useful , Don't forget to give it a star

host_file_location.png

12.7 KB
Loading

sites_to_block.png

9.48 KB
Loading

0 commit comments

Comments
 (0)