INNER CODE UNIT · Python
__init__
mfarragher/obsidiantools · obsidiantools/api.py:35
def __init__(self, dirpath: Path, *,
include_subdirs: list[str] = None, include_root: bool = True):
"""A Vault object lets you dig into your Obsidian vault, by giving
you a toolkit for analysing its contents. Specify a dirpath to
instantiate the class. This class is intended to support multiple
operating systems so pass a pathlib Path object.
By calling CONNECT you generate a graph of your vault.
All the wikilinks in the vault are used to produce the graph, to
reflect how analytics are displayed in Obsidian, where links are
counted rather than notes. For example, if a note has 2 backlinks
then there will be 2 wikilinks (to another note) visible when you do
analysis of the edges & nodes.
Detail on canvas files is also stored when calling this method.
By calling GATHER you store the plaintext of your vault in the notes
index attribute. You can specify rules for how the text is
processed, e.g. whether code blocks should be removed.