hyperdiary package¶
Submodules¶
hyperdiary.diary module¶
-
class
hyperdiary.diary.
DayEntry
(dt: datetime.date, lines: List[str])[source]¶ Bases:
object
Diary entry for a specific date, contains multiple lines of text.
-
class
hyperdiary.diary.
Diary
(hyperdiary_json: Mapping[KT, VT_co])[source]¶ Bases:
object
-
class
hyperdiary.diary.
Token
(type: hyperdiary.diary.TokenType, text: str, ref: str = None)[source]¶ Bases:
object
-
class
hyperdiary.diary.
TokenType
[source]¶ Bases:
enum.Enum
An enumeration.
-
Id
= 3¶
-
Tag
= 2¶
-
Text
= 1¶
-
>>> line = "+tag1 +tag2 some content goes here +tag3" >>> res = [t.text for t in find_tags(line)] >>> res == ["tag1", "tag2", "tag3"] True
hyperdiary.html module¶
-
hyperdiary.html.
append_li_a
(ul: hyperdiary.htmltags.HTMLElement, text: str, href: str) → None[source]¶
-
hyperdiary.html.
day_to_html
(current: datetime.date, entry: Iterable[str], localization: hyperdiary.localization.Localization, link_to_id_fn: Callable[[Optional[str]], str] = None) → hyperdiary.htmltags.HTMLElement[source]¶
-
hyperdiary.html.
diary_to_html_folder
(diary_instance: hyperdiary.diary.Diary, folder: str) → None[source]¶
-
hyperdiary.html.
rel_path
(spath: Union[datetime.date, str, int]) → hyperdiary.simplepath.RelativePath[source]¶
hyperdiary.htmltags module¶
Bases:
object
hyperdiary.hugo module¶
hyperdiary.localization module¶
-
class
hyperdiary.localization.
Localization
(months: List[str] = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'], days_short: List[str] = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'], date_fmt: str = '%Y-%m-%d')[source]¶ Bases:
object
-
format_date
(dt: datetime.date) → str[source]¶ Format to localized string. >>> l = Localization() >>> l.format_date(date(2019, 11, 3)) ‘2019-11-03’ >>> l = Localization(date_fmt=’%d.%m.%Y’) >>> l.format_date(date(2019, 11, 3)) ‘03.11.2019’
-
get_day_short
(i: int) → str[source]¶ Get the localized name of day i (zero-based index starting Monday). >>> l = Localization() >>> l.get_day_short(0) ‘Mon’ >>> l.get_day_short(6) ‘Sun’ >>> l.get_day_short(7) Traceback (most recent call last): … AssertionError >>> Localization(days_short=[‘Just Mon’]) Traceback (most recent call last): … AssertionError >>> l2 = Localization(days_short=list(‘1234567’)) >>> l2.get_day_short(3) ‘4’ >>> l2.get_day_short(6) ‘7’
-
get_month
(i: int) → str[source]¶ Get the localized name of month i (zero-based index). >>> l = Localization() >>> l.get_month(0) ‘January’ >>> l.get_month(11) ‘December’ >>> l.get_month(12) Traceback (most recent call last): … AssertionError >>> Localization(months=[‘Just January’]) Traceback (most recent call last): … AssertionError >>> l2 = Localization(months=list(‘123456789ond’)) >>> l2.get_month(3) ‘4’ >>> l2.get_month(10) ‘n’
-
hyperdiary.simplepath module¶
hyperdiary.stats module¶
hyperdiary.tiddlywiki module¶
-
class
hyperdiary.tiddlywiki.
Tiddler
(fname: Union[pathlib.Path, str], **fields)[source]¶ Bases:
object
-
static
from_entry
(dt: datetime.date, entry: Iterable[str], localization: hyperdiary.localization.Localization) → hyperdiary.tiddlywiki.Tiddler[source]¶
-
text
¶
-
title
¶
-
static
-
hyperdiary.tiddlywiki.
diary_to_tiddlers
(diary_instance: hyperdiary.diary.Diary) → Iterator[hyperdiary.tiddlywiki.Tiddler][source]¶
-
hyperdiary.tiddlywiki.
diary_to_tiddlers_export
(diary_instance: hyperdiary.diary.Diary, tiddler_dir: Union[pathlib.Path, str]) → None[source]¶
-
hyperdiary.tiddlywiki.
diary_to_tiddlywiki_export
(diary_instance: hyperdiary.diary.Diary, file: Union[pathlib.Path, str], tiddlywiki_base_file: Union[pathlib.Path, str]) → None[source]¶
-
hyperdiary.tiddlywiki.
make_tiddler_filename
(o: Union[str, datetime.date]) → str[source]¶ >>> make_tiddler_filename(" Frühstück Ähre Grüße Föhn") 'fruehstueck-aehre-gruesse-foehn.tid' >>> make_tiddler_filename("a.v-_'üöß' tiddler") 'av-_ueoess-tiddler.tid' >>> make_tiddler_filename(date(2019, 2, 3)) '2019-02-03.tid'