Skip to content

Latest commit

 

History

History
99 lines (58 loc) · 2.36 KB

README.md

File metadata and controls

99 lines (58 loc) · 2.36 KB
Raw

pyplanner

Stars forks lang

This is the official pyplanner repository.

This lightweight application allows you to quickly schedule your activities.

pyplanner keeps track of all your activities and notifies you when they are due.

Getting Started

  1. Fork this repository.

  2. Clone the repository.

git@github.com:<username>/pyplanner.git
  1. Go to the directory
cd pyplanner
  1. Install all the dependencies.
pip3 install -r requirements.txt
  1. Run the following command
python3 -m pyplanner set_task <task-name> <time-scheduled>

That's it! You have scheduled a task.

reminder

System Requirements

This app is supported in Linux as of now. So if you have any Linux distribution (Ubuntu, Fedora, Manjaro, etc.), you are good to go.

  1. Python (3.8 or higher) and pip (21 or higher)

  2. crontab if it is not installed.

  3. Visual Studio Code (install here)

  4. Git

Note: The installation process differs in different Linux distributions.

Commands

  1. Reset all the tasks or if anything goes wrong.
python3 -m pyplanner reset
  1. Display list of tasks in command line.
python3 -m pyplanner show_tasks

show_tasks

  1. Set a task
python3 -m pyplanner set_task <task-name> <time-scheduled>

Plans

  • Make package of this app
  • Add / Remove Tasks using Textualize TUI library.
  • Add test cases to validate before merging PR.

Contributing

  • Make sure you read contributing guidelines first.

  • Follow our code of conduct. Violation of any rule will lead to disqualification from Hacktoberfest 2022.

  • Follow PR template and issue template accordingly before creating any issue/PR.

License

Licensed under MIT License

Copyright (c) 2022 Subhendu Dash