TheFiche

TheFiche

TheFiche is a script that generates and exports Logseq pages based on WDoc queries. It provides functionality to create structured Logseq pages with content generated from WDoc queries, including metadata and properties. The name "TheFiche" is french for "TheCheatsheet" only it's more like a comprehensive sheet and no relations to "cheating".

Features

• Generate Logseq pages from WDoc queries
• Include metadata and properties in the generated pages
• Customizable query parameters
• Integration with WDoc for document processing
• Automatically finds important words in the text to create logseq links directly. (For example turn cancer into [[cancer]])

Installation

To use TheFiche, you need to have WDoc and its dependencies installed. Make sure you have the following prerequisites:

• WDoc
• LogseqMarkdownParser (by me also)
• fire
• beartype
• joblib

You can install the required dependencies using pip:

python -m pip install -U WDoc LogseqMarkdownParser fire beartype joblib

Usage

To use TheFiche, you can import it in your Python script or use it from the command line.

Python Script

from TheFiche import TheFiche

TheFiche(
    query="Your query here",
    logseq_page="path/to/output.md",
    overwrite=False,
    top_k=300
)

Command Line

python TheFiche.py --query="Your query here" --logseq_page="path/to/output.md" --overwrite=False --top_k=300

Parameters

• query (str): The query to be processed by WDoc.
• logseq_page (Union[str, PosixPath]): The path to the Logseq page file.
• overwrite (bool, optional): Whether to overwrite an existing file. Defaults to False. If False, will append to the file instead of overwriting. Else, will also overwrite sources if present.
• top_k (int, optional): The number of top documents to consider. Defaults to 300.
• sources_location (str): If 'as_pages', will store each source as its own page in a 'TheFiche___' namespace. If 'below', sources will be written at the end of the page. Default to "as_pages".
• sources_ref_as_prop (bool): if True, make sure the sources appear as block properties instead of leaving them as is. Default to False.
• use_cache (bool): set to False to bypass the cache, default True.
• logseq_linkify (bool): If True, will ask WDoc's strong LLM to find the import keywords and automatically replace them in the output file by logseq [[links]], enabling the use of graph properties. Default to True.
• **kwargs: Additional keyword arguments to pass to WDoc.

Output

TheFiche generates a Logseq page with the following components:

• Content generated from the WDoc query
• Page properties including:
  • WDoc version and model information
  • Number of documents found, filtered, and used
  • Query details and timestamp
  • TheFiche version and execution date