Skip to content

EconoBen/headsdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Heads Down

A Mac app that lives in your ribbon—with a click of the mouse, temporarily block distracting websites and applications to encourage "heads down" time.

Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Troubleshooting
  5. Roadmap
  6. Contributing
  7. License
  8. Contact

About The Project

This project was inspired by a tweet.

The person in question had a simple request: how can I block distracting apps and websites when I'm trying to work?

With Heads Down, you can easily block and unblock websites and apps with a click of the mouse.

Built With

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • git
  • pip
  • python

Installation

  1. Clone the repo
    git clone https://github.com/EconoBen/headsdown.git
  2. Change the directory
    cd headsdown/
  3. Install the required libraries
    pip install -r requirements.txt
  4. Install Heads Down
    python setup.py py2app --iconfile images/icon.icns
  5. Move the Heads Down app to your Applications folder
    mv dist/headsdown.app /Applications

Usage

Heads down comes with a list of predefined social media websites to block (see block_sites.csv). To add to the block list, simply select the "block sites" button and a popup window in which to add websites will appear.

To begin a work session, simply cick on the "Heads Down" button. When you're done, select "Heads Up". It's that easy.

Troubleshooting

  1. setup.py returns an error like (libpython3.8.dylib does not exist). Try running:
    ln -s PATH/TO/FILE/libpython3.8m.dylib PATH/TO/FILE/libpython3.8.dylib

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 GPL-3.0 License. See LICENSE for more information.

Contact

Benjamin Labaschin - @econoben - benjaminlabaschin@gmail.com

Project Link: https://github.com/EconoBen/headsdown

About

Heads Down Application for Mac OSX

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages