Assignment Manager

A terminal based assignment-manager written in python. It can handle both one-time tasks and recurring assignments. Also allows you to track your progress.

Features

The following features are present in the current version

• Reoccuring assignments
• Track progress on each assignment
• Display assignments in sorted table
• Make back up of assignment data
• Edit existing assignments

And these features still need to be implemented

• [ ] Special class of one-time assignments
• [ ] Undo last action taken

Prerequisites

All you need in order to use this repo is python>=3.8. Note that there are some python dependencies, however most of them should be available for all OS's.

Installation

If you have pipx, run

pipx install assignment-manager

otherwise you can just run

pip install assignment-manager

Note that if you are using pip, you may want to setup a venv.

Usage

You use the following two keywords as entry points

assman
assignment-manager

To view the help panel, write

$ assman --help

 Usage: assman [OPTIONS] COMMAND [ARGS]...                                                          

╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion        [bash|zsh|fish|powershell|pwsh]  Install completion for the          │
│                                                              specified shell.                    │
│                                                              [default: None]                     │
│ --show-completion           [bash|zsh|fish|powershell|pwsh]  Show completion for the specified   │
│                                                              shell, to copy it or customize the  │
│                                                              installation.                       │
│                                                              [default: None]                     │
│ --help                                                       Show this message and exit.         │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ add                                                                                              │
│ backup                                                                                           │
│ remove                                                                                           │
│ rename                                                                                           │
│ show                                                                                             │
│ update                                                                                           │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯

Note that some commands have some subcommands

$ assman backup --help

╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ copy              Copy the data file. This will OVERWRITE the BACKUP file    │
│ paste             Paste the backup file. This will OVERWRITE the DATA file   │
╰──────────────────────────────────────────────────────────────────────────────╯

$ assman show --help

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --one     --no-one       [default: no-one]                                   │
│ --sort    --no-sort      [default: no-sort]                                  │
╰──────────────────────────────────────────────────────────────────────────────╯

Contributing

Contributions of any kind to this project are very welcome!