Metadata-Version: 2.1
Name: beproductive
Version: 0.1.1
Summary: Block distracting websites and set up a Pomodoro timer. Focus on your work.
Home-page: https://github.com/johannesstutz/beproductive/tree/master/
Author: Johannes Stutz
Author-email: johannesstutz@gmail.com
License: Apache Software License 2.0
Description: # Be Productive
        > A tool that let's you focus on your work by blocking distracting websites. Optionally with a timer for work sessions, using the Pomodoro technique.
        
        
        ## Install
        
        To install **Be Productive**:
        ```pip install beproductive```
        
        If you use Windows, it's recommended to `pip install win10toast` for [nice Windows notifications](https://github.com/jithurjacob/Windows-10-Toast-Notifications). 
        
        ![](pomodoro-notification.png)
        
        You don't have to install `win10toast`, but without it you will not get visible and audible notifications for Pomodoro. However, all notifications are also printed in your command line interface.
        
        ## Blocked Websites
        
        These websites are blocked per default, but you can always edit `blocklist.txt` and add your personal time killers.
        
        ```python
        #collapse_input
        with open(BLOCKLIST) as file:
            print(" ".join([line.rstrip() for line in file]))
        ```
        
            twitter.com youtube.com facebook.com instagram.com reddit.com netflix.com amazon.com linkedin.com
        
        
        ## How to Block / Unblock Websites
        
        ### Windows
        To run the blocker script, **you have to run your command line tool with administrator privileges.**
        
        Block websites:
        ```
        cd /directory/of/beproductive
        python -m beproductive
        ```
        Block websites for `x` minutes:
        ```
        python -m beproductive block 45
        ```
        Unblock all websites:
        ```
        python -m beproductive unblock
        ```
        
        Start a Pomodoro session:
        ```
        python -m beproductive pomodoro
        ```
        
        ### Linux (and MacOS?)
        Block websites:
        ```
        cd /directory/of/beproductive
        sudo python -m beproductive [block]
        ```
        Block websites for `x` minutes:
        ```
        sudo python -m beproductive block 45
        ```
        Unblock all websites:
        ```
        sudo python -m beproductive unblock
        ```
        
        Start a Pomodoro session:
        ```
        sudo python -m beproductive pomodoro
        ```
        
        ### Pomodoro
        The [Pomodoro](https://en.wikipedia.org/wiki/Pomodoro_Technique) feature blocks your defined websites for 25 minutes. It notifies you after the 25 minutes are over and gives you access to all websites for 5 minutes. Although I recommend getting up and stretching instead :) This cycle is repeated 4 times.
        
        You can set custom times. This is how you run 5 Pomodoros of 45 minutes with 10 minute breaks:
        ```
        python -m beproductive pomodoro 45 10 5
        ```
        
        ## Behind the Scenes
        The script blocks URLs by modifying the `hosts` file. Blocked URLs are redirected to `127.0.0.1`. The script backs up the original `hosts` file. You will not lose any customizations and you can always reset to the original state.
        
        ## Roadmap
        - Turn scripts into installable Python package
        - Extend to Linux and MacOS
        - Add ability to schedule or block for specific period of time
        
Keywords: nbdev,productivity
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
