Skip to content

Latest commit

 

History

History

todo-python

Todo list in Python

pre-commit Tests status Linting status codecov Documentation

A Todo list manager written in Python

About

Project Team

Milan Malfait (@milanmlft)

Getting Started

Prerequisites

todo-python requires Python 3.12.

Installation

We recommend installing in a project specific virtual environment created using a environment management tool such as Mamba or Conda. To install the latest development version of todo-python using pip in the currently active environment run

git clone https://github.com/milanmlft/todo.git

and then install in editable mode by running

pip install -e ./todo-python

Running Tests

Tests can be run across all compatible Python versions in isolated environments using tox by running

tox

To run tests manually in a Python environment with pytest installed run

pytest tests

again from the root of the repository.

Roadmap

  • Set up initial project structure
  • Set up app initialisation
  • Set up todo back-end
  • Implement adding and listing todo's
  • Implement todo completion functionality
  • Implement removing todo's
  • Add support for dates and deadlines
  • Increase code coverage

Acknowledgements

This work was funded by a grant from the JBFC: The Joe Bloggs Funding Council.