Inkycal/docs/searchindex.js

Search.setIndex({"alltitles": {"About Inkycal": [[0, "about-inkycal"]], "Contents:": [[2, null]], "Creating settings file": [[4, "creating-settings-file"]], "Custom functions": [[3, "module-inkycal.custom.functions"]], "Developer documentation": [[1, "developer-documentation"]], "Display": [[3, "module-inkycal.display.Display"]], "Helper classes": [[3, "module-inkycal.modules.ical_parser"]], "Indices and tables": [[2, "indices-and-tables"]], "Inkycal": [[3, "module-inkycal.main"]], "Inkycal documentation": [[2, "inkycal-documentation"]], "Installing Inkycal": [[4, "installing-inkycal"]], "Quickstart": [[4, "quickstart"]]}, "docnames": ["about", "dev_doc", "index", "inkycal", "quickstart"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["about.md", "dev_doc.md", "index.rst", "inkycal.rst", "quickstart.md"], "indexentries": {"all_day() (inkycal.modules.ical_parser.icalendar static method)": [[3, "inkycal.modules.ical_parser.iCalendar.all_day", false]], "auto_fontsize() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.auto_fontsize", false]], "autoflip() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.autoflip", false]], "calibrate() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.calibrate", false]], "clear() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.clear", false]], "clear_events() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.clear_events", false]], "countdown() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.countdown", false]], "draw_border() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.draw_border", false]], "dry_run() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.dry_run", false]], "flip() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.flip", false]], "get_events() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.get_events", false]], "get_fonts() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.get_fonts", false]], "get_system_tz() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.get_system_tz", false]], "get_system_tz() (inkycal.modules.ical_parser.icalendar static method)": [[3, "inkycal.modules.ical_parser.iCalendar.get_system_tz", false]], "icalendar (class in inkycal.modules.ical_parser)": [[3, "inkycal.modules.ical_parser.iCalendar", false]], "image_to_palette() (in module inkycal.modules.inky_image)": [[3, "inkycal.modules.inky_image.image_to_palette", false]], "inkycal (class in inkycal.main)": [[3, "inkycal.main.Inkycal", false]], "inkycal.custom.functions": [[3, "module-inkycal.custom.functions", false]], "inkycal.display.display": [[3, "module-inkycal.display.Display", false]], "inkycal.main": [[3, "module-inkycal.main", false]], "inkycal.modules.ical_parser": [[3, "module-inkycal.modules.ical_parser", false]], "inkycal.modules.inky_image": [[3, "module-inkycal.modules.inky_image", false]], "inkyimage (class in inkycal.modules.inky_image)": [[3, "inkycal.modules.inky_image.Inkyimage", false]], "internet_available() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.internet_available", false]], "load() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.load", false]], "load_from_file() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.load_from_file", false]], "load_url() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.load_url", false]], "merge() (inkycal.modules.inky_image.inkyimage static method)": [[3, "inkycal.modules.inky_image.Inkyimage.merge", false]], "module": [[3, "module-inkycal.custom.functions", false], [3, "module-inkycal.display.Display", false], [3, "module-inkycal.main", false], [3, "module-inkycal.modules.ical_parser", false], [3, "module-inkycal.modules.inky_image", false]], "preview() (inkycal.modules.inky_image.inkyimage static method)": [[3, "inkycal.modules.inky_image.Inkyimage.preview", false]], "process_module() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.process_module", false]], "remove_alpha() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.remove_alpha", false]], "resize() (inkycal.modules.inky_image.inkyimage method)": [[3, "inkycal.modules.inky_image.Inkyimage.resize", false]], "run() (inkycal.main.inkycal method)": [[3, "inkycal.main.Inkycal.run", false]], "show_events() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.show_events", false]], "sort() (inkycal.modules.ical_parser.icalendar method)": [[3, "inkycal.modules.ical_parser.iCalendar.sort", false]], "text_wrap() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.text_wrap", false]], "write() (in module inkycal.custom.functions)": [[3, "inkycal.custom.functions.write", false]]}, "objects": {"inkycal": [[3, 0, 0, "-", "main"]], "inkycal.custom": [[3, 0, 0, "-", "functions"]], "inkycal.custom.functions": [[3, 1, 1, "", "auto_fontsize"], [3, 1, 1, "", "draw_border"], [3, 1, 1, "", "get_fonts"], [3, 1, 1, "", "get_system_tz"], [3, 1, 1, "", "internet_available"], [3, 1, 1, "", "text_wrap"], [3, 1, 1, "", "write"]], "inkycal.display": [[3, 0, 0, "-", "Display"]], "inkycal.main": [[3, 2, 1, "", "Inkycal"]], "inkycal.main.Inkycal": [[3, 3, 1, "", "calibrate"], [3, 3, 1, "", "countdown"], [3, 3, 1, "", "dry_run"], [3, 3, 1, "", "process_module"], [3, 3, 1, "", "run"]], "inkycal.modules": [[3, 0, 0, "-", "ical_parser"], [3, 0, 0, "-", "inky_image"]], "inkycal.modules.ical_parser": [[3, 2, 1, "", "iCalendar"]], "inkycal.modules.ical_parser.iCalendar": [[3, 3, 1, "", "all_day"], [3, 3, 1, "", "clear_events"], [3, 3, 1, "", "get_events"], [3, 3, 1, "", "get_system_tz"], [3, 3, 1, "", "load_from_file"], [3, 3, 1, "", "load_url"], [3, 3, 1, "", "show_events"], [3, 3, 1, "", "sort"]], "inkycal.modules.inky_image": [[3, 2, 1, "", "Inkyimage"], [3, 1, 1, "", "image_to_palette"]], "inkycal.modules.inky_image.Inkyimage": [[3, 3, 1, "", "autoflip"], [3, 3, 1, "", "clear"], [3, 3, 1, "", "flip"], [3, 3, 1, "", "load"], [3, 3, 1, "", "merge"], [3, 3, 1, "", "preview"], [3, 3, 1, "", "remove_alpha"], [3, 3, 1, "", "resize"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method"}, "terms": {"": [0, 3], "0": 3, "1": 3, "10": 3, "100": 3, "11": 3, "16": 3, "16grai": 3, "180": 3, "2": 3, "20": 3, "270": 3, "3": 3, "32": 3, "360": 3, "5": 3, "7": 3, "80": 3, "9": 3, "90": 3, "A": 3, "If": 3, "In": 3, "It": 0, "No": 0, "OR": 3, "The": [0, 3], "Then": 3, "To": 3, "_": 0, "about": 2, "access": 3, "accur": 3, "aceinnolab": [3, 4], "aceisac": 0, "actual": 3, "ad": 0, "add": 3, "adjust": 3, "after": 3, "agenda": 0, "align": 3, "aliv": 0, "all": [0, 3], "all_dai": 3, "allow": 3, "alpha": 3, "also": 0, "amount": 0, "an": 3, "angl": 3, "anti": 3, "anyth": 0, "arg": 3, "arrow": 3, "assembl": 3, "async": 3, "atom": 0, "attempt": 3, "attribut": 3, "auto_fonts": [2, 3], "autofit": 3, "autoflip": 3, "automat": 3, "avail": 3, "awar": 3, "band": 3, "base": 3, "befor": 3, "begin": 3, "behind": 0, "below": 3, "black": 3, "blend": 0, "bool": 3, "boot": 3, "border": 3, "box": 3, "box_siz": 3, "built": 0, "bw": 3, "bwr": 3, "bwy": 3, "calcul": 3, "calendar": 0, "calibr": 3, "can": [0, 3], "care": [0, 3], "case": 0, "caus": 3, "cd": 4, "center": 3, "chang": 3, "check": 3, "choos": 3, "chunk": 3, "class": 2, "clear": 3, "clear_ev": 3, "clockwis": 3, "clone": 4, "co": 3, "coffe": 0, "colour": 3, "com": [3, 4], "come": 4, "commerci": 0, "commonli": 3, "commun": 0, "compat": 0, "config": 3, "connect": 3, "contain": 3, "coordin": 3, "copi": 4, "copyright": 3, "corner": 3, "correct": 3, "correctli": 3, "could": 3, "countdown": 3, "cours": 0, "creat": [0, 1, 2, 3], "current": 3, "custom": 2, "cycl": 3, "dai": 3, "dashboard": 0, "date": 3, "dd": 3, "decim": 3, "default": 3, "defin": 3, "desir": 3, "desktop": 3, "detail": 0, "develop": [0, 2], "dictionari": 3, "directli": 4, "discord": 0, "displai": [0, 2], "dither": 3, "do": 3, "doesn": [0, 3], "don": 0, "donat": 0, "download": [3, 4], "draw": 3, "draw_bord": [2, 3], "drawn": 3, "driver": 3, "dry_run": 3, "e": [0, 3, 4], "each": 3, "eas": 3, "edit": 0, "effort": 0, "els": 3, "en": 3, "end": 3, "environ": 0, "epap": 3, "epaper_model": 3, "establish": 3, "etc": 0, "even": 0, "event": [0, 3], "exampl": 3, "except": 3, "exit": 3, "extract": 3, "face": 0, "fals": 3, "feed": 0, "fetch": 0, "few": 0, "file": [0, 2, 3], "filenotfounderror": 3, "filepath": 3, "fill": 3, "fill_height": 3, "fill_width": 3, "first": 3, "fit": 3, "flag": 3, "flip": 3, "fmt": 3, "folder": [3, 4], "follow": 3, "font": 3, "fontfil": 3, "fontnam": 3, "fontsiz": 3, "forecast": 0, "form": 0, "format": 3, "found": 3, "free": 0, "friendli": 0, "from": [0, 3], "full": [0, 3], "fulli": 0, "function": 2, "g": 3, "gener": [3, 4], "get": [0, 3], "get_ev": 3, "get_font": [2, 3], "get_system_tz": [2, 3], "git": 4, "github": 4, "given": 3, "go": 4, "googl": [0, 3], "gpicview": 3, "grai": 3, "greater": 3, "ha": [0, 3], "handl": 3, "have": [0, 3], "height": 3, "height_shrink_percentag": 3, "help": 0, "helper": 2, "hh": 3, "home": 3, "horizont": 3, "hour": 0, "htpp": 3, "http": [3, 4], "i": [0, 1, 3], "ical_pars": 3, "icalendar": [0, 2, 3], "idea": 0, "im_black": 3, "im_colour": 3, "imag": 3, "image1": 3, "image2": 3, "image_to_palett": [2, 3], "imagefont": 3, "imga": 3, "import": 3, "improv": 3, "increas": 3, "indefinit": 3, "index": 2, "individu": 3, "infin": 3, "info": 3, "inform": 0, "initi": 3, "inky_imag": 3, "inkyimag": [2, 3], "input": 3, "instal": 2, "instanc": 3, "instead": 3, "int": 3, "integ": 3, "internet": 3, "internet_avail": [2, 3], "interv": 3, "interval_min": 3, "invest": 0, "io": 3, "issu": 3, "iter": 3, "its": 0, "joke": 0, "json": 3, "keep": 0, "kwarg": 3, "larg": 0, "latest": [0, 3], "layout": 3, "left": 3, "lib": 3, "line": 3, "list": 3, "liter": 3, "load": 3, "load_from_fil": 3, "load_url": 3, "local": 3, "logo": 3, "long": 3, "look": [0, 3], "loop": 3, "made": 3, "mai": 0, "main": [0, 3], "mainli": [0, 1], "map": 3, "max_height": 3, "max_width": 3, "maximum": 3, "mean": 0, "merg": 3, "minut": 3, "miss": 0, "mm": 3, "mmm": 3, "mode": 3, "model": 3, "modifi": 3, "modul": [0, 1, 2, 3], "modular": 0, "monthli": 0, "more": [0, 3, 4], "moudul": 3, "much": 3, "multipl": 3, "name": 3, "navig": 4, "need": 0, "network": 3, "new": [0, 3], "next": [0, 3], "nice_p": 3, "non": [0, 3], "none": 3, "nonstop": 3, "noob": 0, "noth": 0, "now": 3, "number": 3, "object": 3, "onc": 3, "one": 3, "ones": 3, "onli": 3, "open": 0, "oper": 3, "optim": 3, "option": 3, "order": 3, "ordin": 3, "organis": 0, "oserror": 3, "other": [0, 3], "output": 3, "own": 0, "packag": 3, "page": 2, "palett": 3, "paper": [0, 3], "paramet": 3, "pars": 3, "part": 3, "parti": [0, 1], "password": 3, "past": 3, "path": 3, "path1": 3, "path2": 3, "percentag": 3, "phone": 0, "pi": [0, 3, 4], "pil": 3, "pinch": 0, "pip3": 4, "pixel": 3, "plain": 3, "pleas": [0, 4], "png": 3, "point": 3, "posit": 3, "possibl": 3, "present": 3, "preview": 3, "previous": 3, "print": 3, "process": 3, "process_modul": 3, "program": 3, "project": [0, 3], "protect": 3, "provid": 0, "py": 3, "python3": [0, 3], "quickstart": 2, "radiu": 3, "rais": 3, "rapsbian": 3, "raspberri": [0, 4], "raw": 3, "re": 0, "reach": 3, "readabl": 3, "readthedoc": 3, "rectangl": 3, "red": 3, "reduc": 3, "refresh": 3, "remain": 3, "remov": 3, "remove_alpha": 3, "render": 3, "replac": 3, "repo": 4, "repres": 3, "requir": 3, "resiz": 3, "return": 3, "rgba": 3, "right": 3, "rotat": 3, "round": 3, "rss": 0, "run": [0, 3], "run_onc": 3, "runner": 3, "sampl": 3, "save": 3, "scale": 3, "schedul": 3, "search": [2, 3], "second": 3, "see": 3, "select": [0, 3], "set": [0, 2, 3], "settings_path": 3, "sever": 0, "shade": 3, "share": 0, "should": 3, "show": [0, 3], "show_ev": 3, "shown": 3, "shrink": 3, "shrinkag": 3, "shutdown_after_run": 3, "singl": 3, "site": 3, "size": 3, "sleep": 3, "smaller": 3, "smile": 0, "softwar": 0, "solid": 3, "some": 0, "someth": [0, 3], "soon": 4, "sort": 3, "sourc": 0, "specifi": 3, "split": 3, "stai": 0, "start": 3, "static": 3, "stop": 3, "str": 3, "string": 3, "student": 0, "support": [0, 3], "sync": 0, "synchronis": 0, "system": 3, "sytax": 3, "t": [0, 3], "take": [0, 3], "test": 3, "text": 3, "text_wrap": [2, 3], "than": 3, "thank": 0, "them": [0, 3], "thi": [0, 1, 3], "thick": 3, "third": [0, 1], "time": [0, 3], "timelin": 3, "timeline_end": 3, "timeline_start": 3, "timeout": 3, "timezon": 3, "token": 3, "too": 0, "top": 3, "transpar": 3, "tri": 3, "true": 3, "truetyp": 3, "tupl": 3, "two": 3, "type": 3, "typeerror": 3, "tz": 3, "u": 0, "ui": [0, 4], "univers": 0, "until": 3, "up": 0, "updat": 3, "url": 3, "url1": 3, "url2": 3, "us": 3, "use_pi_sugar": 3, "user": 0, "usernam": 3, "usual": 3, "utc": 3, "valid": 3, "valu": 3, "valueerror": 3, "venv": 3, "veri": 3, "vertic": 3, "via": [0, 4], "wa": [0, 3], "wai": 3, "we": 0, "weather": 0, "web": [0, 4], "week": 0, "welcom": 0, "well": 0, "what": 0, "when": 3, "where": 3, "which": [0, 3], "white": 3, "who": 1, "width": 3, "width_shrink_percentag": 3, "wish": 1, "without": [0, 3], "work": [0, 3], "write": [0, 2, 3], "written": 3, "x": 3, "xy": 3, "y": 3, "yai": 0, "yellow": 3, "you": 0, "your": [0, 3, 4], "yy": 3, "zero": 0}, "titles": ["About Inkycal", "Developer documentation", "Inkycal documentation", "Inkycal", "Quickstart"], "titleterms": {"about": 0, "class": 3, "content": 2, "creat": 4, "custom": 3, "develop": 1, "displai": 3, "document": [1, 2], "file": 4, "function": 3, "helper": 3, "indic": 2, "inkyc": [0, 2, 3, 4], "instal": 4, "quickstart": 4, "set": 4, "tabl": 2}})