Schemdule is a tiny tool using script as schema to schedule one day and remind you to do something during a day.
- Platform
- Python
Install
Use pip:
pip install schemdule
Or use pipx:
# Install pipx
pip install --user pipx
pipx ensurepath
# Install Schemdule
pipx install schemdule
# Install extension
pipx inject schemdule schemdule-extensions-{extension name}
# Upgrade
pipx upgrade schemdule --include-injected
Usage
Write a Schema
An example schema.
# Schema
at("6:30", "Get up")
cycle("8:00", "12:00", "00:30:00", "00:10:00", "Working")
# Import other schema by `load` function
# load("other_schema.py")
prompter.useTkinterMessageBox()
# ext("simplegui") # use simplegui extension (package schemdule-extensions-simplegui)
# use multiple prompter:
# prompter.useBroadcaster().useConsole().useMessageBox(True)
The built timetable is like the following one from the results of the command schemdule run schema.py --preview.
๐ก 06:30:00 - ๐ 08:00:00 ๐ Get up
๐ 08:00:00 - ๐ฃ 08:30:00 ๐ผ Working (cycle 1 starting)
๐ฃ 08:30:00 - ๐ฃ 08:40:00 โ Working (cycle 1 resting starting)
๐ฃ 08:40:00 - ๐ 09:10:00 ๐ผ Working (cycle 2 starting)
๐ 09:10:00 - ๐ 09:20:00 โ Working (cycle 2 resting starting)
๐ 09:20:00 - ๐ค 09:50:00 ๐ผ Working (cycle 3 starting)
๐ค 09:50:00 - ๐ 10:00:00 โ Working (cycle 3 resting starting)
๐ 10:00:00 - ๐ฅ 10:30:00 ๐ผ Working (cycle 4 starting)
๐ฅ 10:30:00 - ๐ฅ 10:40:00 โ Working (cycle 4 resting starting)
๐ฅ 10:40:00 - ๐ 11:10:00 ๐ผ Working (cycle 5 starting)
๐ 11:10:00 - ๐ 11:20:00 โ Working (cycle 5 resting starting)
๐ 11:20:00 - ๐ฆ 11:50:00 ๐ผ Working (cycle 6 starting)
๐ฆ 11:50:00 - ๐ฆ 11:50:00 โ Working (cycle 6 resting starting)
Run
# load and run from the schema
schemdule run schema.py
# or use python
# python -m schemdule run schema.py
# preview the built timetable
schemdule run schema.py --preview
# try the builtin demo (just for testing)
schemdule demo
Schema Specification
Schema is a pure python script, so you can use any python statement in it.
Schemdule provide at, cycle, load and ext functions for registering events, and a PrompterBuilder variable named prompter to config prompter.
These functions and variable can be accessed and modified in the variable
env, a dict for these items provided by Schemdule. You can change theenvvariable to change the execute environment forloadfunction.
None: # register an event at time with message # if payload is a PayloadBuilder, Schemdule will build the final payload automaticly ... def cycle(rawStart: Union[str, time], rawEnd: Union[str, time], rawWorkDuration: Union[str, time, timedelta], rawRestDuration: Union[str, time, timedelta], message: str = "", workPayload: Optional[Callable[[int], Any]] = None, restPayload: Optional[Callable[[int], Any]] = None) -> None: # register a series of events in cycle during start to end # the duration of one cycle = workDuration + restDuration # For each cycle, register 2 event: cycle starting, cycle resting # workPayload and restPayload is the payload generator such as: # def generator(index: int) -> Any: ... # if the returened payload is a PayloadBuilder, Schemdule will build the final payload automaticly, ... def loadRaw(source: str) -> None: # load from a schema source code ... def load(file: str, encoding: str = "utf8") -> None: # load from a schema source code file ... def ext(name: Optional[str] = None) -> None: # use an extension or use all installed extensions (if name is None) # provided by packages `schemdule-extensions-{extension name}` ... def payloads() -> PayloadBuilder: # create a payload builder ... def prompters() -> PrompterBuilder: # create a prompter builder ... # the class PayloadBuilder class PayloadBuilder: def use(self, payload: Any) -> "PayloadBuilder": ... # the class of the variable `prompter` class PrompterBuilder: def use(self, prompter: Union[Prompter, "PrompterBuilder"]) -> "PrompterBuilder": def useBroadcaster(self, final: bool = False) -> "PrompterBuilder": ... def useSwitcher(self, final: bool = False) -> "PrompterBuilder": ... def useConsole(self, final: bool = False) -> "PrompterBuilder": ... def useCallable(self, final: bool = False) -> "PrompterBuilder": ... def useTkinterMessageBox(self, final: bool = False) -> "PrompterBuilder": ... def clear(self) -> "PrompterBuilder": ... # the default value of the variable `prompter` def default_prompter_builder() -> PrompterBuilder: prompter = PrompterBuilder() prompter.useSwitcher().useConsole().useCallable(True).useTkinterMessageBox() return prompter ">
# raw_time can be {hh:mm} or {hh:mm:ss} or a datetime.time object def at(rawTime: Union[str, time], message: str = "", payload: Any = None) -> None: # register an event at time with message # if payload is a PayloadBuilder, Schemdule will build the final payload automaticly ... def cycle(rawStart: Union[str, time], rawEnd: Union[str, time], rawWorkDuration: Union[str, time, timedelta], rawRestDuration: Union[str, time, timedelta], message: str = "", workPayload: Optional[Callable[[int], Any]] = None, restPayload: Optional[Callable[[int], Any]] = None) -> None: # register a series of events in cycle during start to end # the duration of one cycle = workDuration + restDuration # For each cycle, register 2 event: cycle starting, cycle resting # workPayload and restPayload is the payload generator such as: # def generator(index: int) -> Any: ... # if the returened payload is a PayloadBuilder, Schemdule will build the final payload automaticly, ... def loadRaw(source: str) -> None: # load from a schema source code ... def load(file: str, encoding: str = "utf8") -> None: # load from a schema source code file ... def ext(name: Optional[str] = None) -> None: # use an extension or use all installed extensions (if name is None) # provided by packages `schemdule-extensions-{extension name}` ... def payloads() -> PayloadBuilder: # create a payload builder ... def prompters() -> PrompterBuilder: # create a prompter builder ... # the class PayloadBuilder class PayloadBuilder: def use(self, payload: Any) -> "PayloadBuilder": ... # the class of the variable `prompter` class PrompterBuilder: def use(self, prompter: Union[Prompter, "PrompterBuilder"]) -> "PrompterBuilder": def useBroadcaster(self, final: bool = False) -> "PrompterBuilder": ... def useSwitcher(self, final: bool = False) -> "PrompterBuilder": ... def useConsole(self, final: bool = False) -> "PrompterBuilder": ... def useCallable(self, final: bool = False) -> "PrompterBuilder": ... def useTkinterMessageBox(self, final: bool = False) -> "PrompterBuilder": ... def clear(self) -> "PrompterBuilder": ... # the default value of the variable `prompter` def default_prompter_builder() -> PrompterBuilder: prompter = PrompterBuilder() prompter.useSwitcher().useConsole().useCallable(True).useTkinterMessageBox() return prompter
Here are the type annotions for schema.
# Type annotions
from typing import Callable, Union, Any, Dict, Optional
from datetime import time, timedelta
from schemdule.prompters.builders import PrompterBuilder, PayloadBuilder
from schemdule.prompters import Prompter, PrompterHub
at: Callable[[Union[str, time], str, Any], None]
cycle: Callable[[Union[str, time], Union[str, time], Union[str, time, timedelta], Union[str, time, timedelta], str, Optional[Callable[[int], Any]], Optional[Callable[[int], Any]]], None]
loadRaw: Callable[[str], None]
load: Callable[[str], None]
ext: Callable[[Optional[str]], None]
payloads: Callable[[], PayloadBuilder]
payloads: Callable[[], PrompterBuilder]
prompter: PrompterBuilder
env: Dict[str, Any]
12 Oct 17, 2022
5 Jan 25, 2022
10 Jan 16, 2022
1 Jan 14, 2022
1 Dec 20, 2021
28 May 31, 2022
7 Sep 28, 2021
1 Jan 2, 2022
2.5k Jan 3, 2023
3 Dec 17, 2022
18 Dec 31, 2022
14 May 31, 2022
0 Aug 31, 2022
2 Nov 24, 2021
73 Dec 14, 2022
13 Nov 26, 2022
1 Nov 3, 2021
1 Nov 16, 2021
43 Dec 26, 2022