diff --git a/README.md b/README.md index bf3daf3..2b67d2d 100644 --- a/README.md +++ b/README.md @@ -1 +1,105 @@ # 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](https://pypa.github.io/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](https://docs.python.org/3/library/venv.html). + +## 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! diff --git a/docs/demo/showcase.gif b/docs/demo/showcase.gif new file mode 100644 index 0000000..bd8b8ab Binary files /dev/null and b/docs/demo/showcase.gif differ diff --git a/setup.py b/setup.py index 90248bc..2e46541 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ setup( name="assignment-manager", - version="0.1.7", + version="0.1.8", description=("Manage reoccuring assignments and tasks."), long_description=long_description, long_description_content_type="text/markdown",