/just-start

An app to defeat procrastination

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

NO LONGER MAINTAINED

Check out the new app: https://github.com/AliGhahraei/little-by-little

just-start

Build Status Coverage Status

An app to defeat procrastination!

Introduction

Just-Start is a to-do list application and productivity booster. It prevents you from procrastinating (too much).

The program is a wrapper for TaskWarrior with a timer implementing the Pomodoro Technique (time management). It also draws a bit of inspiration from Omodoro.

Features:

  • Configurable pomodoro phase durations
  • Support for multiple configurations (a.k.a. locations) based on the current time and day of the week
  • Desktop notifications
  • Block time-wasting sites while you’re working

Installation and usage

Supported platforms:

  • Linux
  • macOS

Requirements:

Pick a client name from the table below and run:

$ pip install just-start[<client_name>]
$ just-start-<client_name>

So for the urwid client:

$ pip install just-start-urwid
$ just-start-urwid

Press h to see a list of available user actions.

Clients

Name Framework Notes
urwid (recommended) Urwid Inspired by Calcurse. Similar to a graphical application, but in your terminal
term Terminal (none) Example client. Useful for seeing how to write a brand new one but not intended for continuous usage

Development

If you want to help out please install Poetry, clone the repo and run:

$ cd just-start/
$ poetry install

This will ensure you have both the development and install dependencies.

You can also install the package in editable mode to test manually without having to run a build after every change, but you'll need to generate a setup.py since projects using pyproject.toml alone can't be used this way (see the note about editable mode in PEP517 for more info). I use Dephell for this:

$ cd just-start
$ dephell deps convert --from=pyproject.toml --to=setup.py
$ pip install -e just_start

Bug reports

Issues are tracked using GitHub Issues

Running Tests

You just need Poetry and Tox

$ tox