README.md

TermPlanner

Command line application to increase your productivity!

Usage

Initialise a database

To begin using termplanner you must initialise a database.

$ planner init

You only need to initialise the database once. After that you can just reuse it, as the file will already be made.

Add an event to the database

You can then add an event to the database like so:

$ planner add [date][event]
$ planner add "05.06.2018" "Exam day!!!!"

The date and event arguments must be added in as strings.

Manually delete an event from the database

To delete an event from the database input the following:

$ planner checkout [event]

You can also add the following options when using checkout.

• --allow_list prints out a list of remaining events after an event is deleted.
• --disallow_list is the default.

Display a list of events in the database

To show what events are inside the database do this:

$ planner list

Installation

PyPi package

TermPlanner is available on PyPi and can be installed with pip:

$ pip install termplanner

You can also install the latest version of 'planner' from Github:

$ pip install git+https://github.com/ModoUnreal/planner.git

Developer Installation

If you are interested in contributing to 'TermPlanner', run the following commands:

$ git clone https://github.com/ModoUnreal/TermPlanner.git

$ pip install -e

$ pip install -r requirements.txt

$ planner <command> [params] [options]

Unit Tests

Run unit tests in your active python environment:

$ python tests/test_planner.py

Credits

• click by mitsuhiko

Contact Information

You can contact me to discuss the project using my email below:

[email protected]