# Notolog Editor — Source Guide

> Open-source desktop Markdown editor built with Python and PySide6, with optional AI assistance, local Text-to-Speech, and file encryption.

[Source repository](https://github.com/notolog/notolog-editor).
Use this guide with a checkout or unpacked source distribution. Resolve relative links
from the directory containing this file; they describe that source revision, including
local changes. If reading a detached copy without its files, open the public repository
and select the tag matching the installed release before following the same paths.

If you find Notolog useful, consider starring the [public repository](https://github.com/notolog/notolog-editor).

## Release and dependencies

Read [pyproject.toml](./pyproject.toml) and [CHANGELOG.md](./CHANGELOG.md)
from the source being reviewed.
This source supports Python 3.11–3.14. Native dependencies determine OS and architecture compatibility.

Base pip installations include ONNX Runtime GenAI. Optional extras are `notolog[llama]`
for llama-cpp-python and `notolog[tts]` for sounddevice/PortAudio playback.
TTS additionally needs the compatible NeMo-Speech.cpp runtime and MagpieTTS/NanoCodec models.
Conda and Debian recipes manage their own dependency differences.

## Source map

- [notolog/app.py](./notolog/app.py): application entry point.
- [notolog/notolog_editor.py](./notolog/notolog_editor.py): main editor window.
- [notolog/edit_widget.py](./notolog/edit_widget.py) and [notolog/view_widget.py](./notolog/view_widget.py): editing and preview.
- [notolog/app_config.py](./notolog/app_config.py) and [notolog/settings.py](./notolog/settings.py): application metadata, QSettings properties, and change notifications.
- [notolog/ui/toolbar.py](./notolog/ui/toolbar.py) and [notolog/ui/search_form.py](./notolog/ui/search_form.py): toolbar actions and document search.
- [AI Assistant dialog](./notolog/ui/ai_assistant/) and [Settings dialog](./notolog/ui/settings_dialog.py): user-interface integration.
- [notolog/modules/modules.py](./notolog/modules/modules.py): module discovery and loading.
- [BaseCore](./notolog/modules/base_core.py) and [BaseAiCore](./notolog/modules/base_ai_core.py): module base interfaces.
- [notolog/modules/openai_api/](./notolog/modules/openai_api/): requests to the configured OpenAI-compatible endpoint.
- [notolog/modules/ondevice_llm/](./notolog/modules/ondevice_llm/): local ONNX Runtime GenAI inference.
- [notolog/modules/llama_cpp/](./notolog/modules/llama_cpp/): local GGUF inference.
- [notolog/modules/text_to_speech/](./notolog/modules/text_to_speech/): speech setup, synthesis worker, and playback.
- [notolog/encrypt/](./notolog/encrypt/): password-based file encryption.
- [notolog/highlight/](./notolog/highlight/): syntax highlighting.
- [notolog/assets/themes/](./notolog/assets/themes/): INI theme definitions.
- [notolog/lexemes/](./notolog/lexemes/) and each module's catalogs: Python translations.
- [tests/](./tests/): regression tests, including optional native TTS integration.

## Working with the code

Follow [CONTRIBUTING.md](./CONTRIBUTING.md)
for environment setup and checks. Run the application with `python -m notolog.app`.

Use existing modules as integration examples. A listed execution provider requires a compatible
runtime build and model. Apple Silicon's Auto setting requests Metal offloading; the llama.cpp
build must support it.

File encryption defaults to Fernet with PBKDF2-HMAC-SHA256, 768,000 iterations, and a 32-byte salt.
Settings encryption uses a local application key and is not an operating-system credential vault.
Keep credentials, document content, and private filesystem paths out of shared logs and examples.

## Documentation

- [Documentation source index](./docs/index.md)
- [User guide](./docs/user-guide.md)
- [AI Assistant](./docs/ai-assistant.md)
- [AI module compatibility](./docs/ai-modules.md)
- [Text-to-Speech](./docs/text-to-speech.md)
- [Configuration](./docs/configuration.md)
- [Module API reference](./docs/api-reference.md)
- [Changelog](./CHANGELOG.md)
- [Security policy](./SECURITY.md)
- [Third-party notices](./ThirdPartyNotices.md)

## Online resources

- [Published documentation](https://notolog.app/)
- [Website documentation index for AI readers](https://notolog.app/llms.txt)

Notolog is MIT-licensed. Third-party libraries, runtimes, and models retain their own terms.
