/todo-list-tools

Tools for extracting various metadata from one's Remember the Milk lists and smartlists.

Primary LanguageJavaApache License 2.0Apache-2.0

Todo List Tools

Update 2024-06-29: This repo is archived, since I no longer use Remember the Milk and won't make any more updates to this repo. The master branch should be stable, the release/1.0.0 definitely is, but the develop branch is ahead somewhat but I don't think it's stable at all. Please use at your own risk.

Remember the Milk is a service for creating to-do lists. It provides advanced ways to filter and sort items on those to-do lists. I have used the service for many years, and I can highly recommend it. Despite all the praise I have for the service, it lacks some features. That is where this project comes in.

Disclaimer

This product uses the Remember The Milk API but it's not endorsed or certified by Remember The Milk.

Privacy policy

The Todo List Tools collects and processes data from the user's Remember the Milk account. Please read the privacy policy for more information.

Installation

You can choose to either build the app yourself or download a release and run the JAR directly.

Prerequisites for building:

  • JDK 8 or later.
  • Maven (to use my build file directly) or other build tool

Prerequisites for downloaded JAR:

  • JRE 8 or later.

Build it yourself

  1. Download or clone this repository.
  2. Unzip the downloaded file, if applicable.
  3. Open a terminal at the root directory of the repository.
  4. If you're using Maven, execute mvn package. You will get three JAR files under the target subdirectory: todo-list-tools-{version}.jar (contains the runnable app), todo-list-tools-{version}-javadoc.jar (contains the Javadoc) and todo-list-tools-{version}-sources.jar (contains source files). If you're using some other build tool, please refer to the file pom.xml as a guide on what you should do.

Download a release

  1. Choose a release. Click on the version number of your choice. The latest release is on top.
  2. Under the release notes, you will see three different JAR files. For the runnable application, download todo-list-tools-{version}.jar.
  3. Move the downloaded file to your desired directory.

Usage

Before you start

  1. Make sure you have an account on Remember The Milk.
  2. Make sure you have an API key and a shared secret. Apply for those here.
  3. Download or copy the contents of the file app.sample.cfg. Change the property values of key and shared-secret to the corresponding values you received from Remember The Milk in the previous step.
  4. Build or download a runnable JAR file of this application.
  5. Open a terminal and execute the following command: java -jar {path/to/jar-file} {path/to/config-file}.

Main menu

When the application starts, you will be greeted with a disclaimer and privacy policy. After that, the main menu appears. From here, you can do the following things:

  • add Remember The Milk tasks from a CSV file
  • obtain authentication for the application, to allow reading and writing data from and to your Remember The Milk account
  • exit the application

If this is the first time you launch the application, you should obtain authentication first. This will get you an authentication token that will be written to your config file.

Licensing

This project is licensed under an Apache License 2.0. For detailed terms, please read LICENSE.

Third-party

Library Author(s) License
Apache HttpClient The Apache Software Foundation APL 2.0
Apache Log4J2 The Apache Software Foundation APL 2.0
Dom4J MetaStuff Ltd. and Dom4j contributors Custom
Ini4J Ivan Szkiba APL 2.0
Java TUI Johan Nilsson MIT
JetBrains Annotations JetBrains APL 1.0
JUnit 4 JUnit team EPL 1.0
Pair Christoffer Fink MIT

For all third-party licenses, please refer to 3rd-party-licenses.txt for full license terms.