Skip to main content

Notolog Editor

Notolog Markdown Editor

PyPI - Version Conda Version PyPI - Python Version GitHub License GitHub Actions Workflow Status PyPI - Downloads Conda Downloads

Notolog is an open-source Markdown editor built with Python and PySide6, featuring AI-powered assistance and local-first privacy.

📖 Documentation | 🪲 Report Issues | 💡 Request Features | 💬 Discussions


Quick Install

pip install notolog
notolog  # Launch the app
Other installation methods

With llama.cpp support:

pip install "notolog[llama]"

With Text-to-Speech audio support:

pip install "notolog[tts]"

Via Conda:

conda install notolog -c conda-forge

Ubuntu/Debian: Download from notolog-debian releases

From source:

git clone https://github.com/notolog/notolog-editor.git
cd notolog-editor
python3 -m venv notolog_env && source notolog_env/bin/activate
pip install .
python -m notolog.app

Notolog - Python Markdown Editor - UI Example

Features

  • Markdown Editor - Real-time syntax highlighting in edit mode (implemented specifically for Notolog), live preview, adaptive line numbers, code blocks
  • AI Assistant - Supports: OpenAI API, ONNX Runtime GenAI (local), and llama.cpp (local, GGUF models)
  • Text-to-Speech - Read documents or selections aloud locally with NeMo-Speech.cpp and MagpieTTS
  • File Encryption - PBKDF2HMAC key derivation with Fernet (AES-128 CBC mode) for optional file encryption
  • Multi-Language - 19 languages supported
  • Customizable - 6 built-in themes
  • Cross-Platform - Windows, macOS, Linux

See the User Guide for complete feature documentation.

Requirements

  • Python 3.11–3.14 (python.org)
  • 4 GB RAM minimum for the editor; local AI models need additional memory according to their requirements

Installation

Using a virtual environment is recommended:

python3 -m venv notolog_env
source notolog_env/bin/activate  # Linux/macOS
notolog_env\Scripts\activate     # Windows
pip install notolog

For detailed instructions including conda and Debian packages, see Getting Started.

AI Assistant

Notolog supports three AI backends:

  • OpenAI API - Cloud-based inference via OpenAI-compatible endpoints
  • On-Device LLM - Local inference using ONNX Runtime GenAI (e.g. Phi-3, Llama)
  • Module llama.cpp - Local inference with GGUF quantized models (e.g. Llama, Mistral, Qwen)

See the AI Assistant Guide for setup instructions.

Text-to-Speech

Notolog reads documents, selections, or text from the cursor aloud locally using NeMo-Speech.cpp and MagpieTTS, with play, pause, and stop controls.

For pip installations, install audio support with pip install "notolog[tts]". The compatible runtime and models require separate downloads.

See the Text-to-Speech Guide for setup, supported languages, and troubleshooting.

Development

git clone https://github.com/notolog/notolog-editor.git
cd notolog-editor
python3 -m venv .venv && source .venv/bin/activate
pip install -e .
python -m notolog.app

Run tests:

python dev_install.py test
python -m pytest

See CONTRIBUTING.md for guidelines.

License

Notolog is open-source software licensed under the MIT License.

This project uses third-party libraries, each subject to its own license. See ThirdPartyNotices.md for details.

Security

Notolog prioritizes data protection and user privacy:

  • Encryption: File encryption (optional) uses PBKDF2HMAC key derivation with Fernet (AES-128 CBC mode).
  • Auto-Save: Changes are saved automatically to prevent data loss.
  • Privacy: Notolog's own code has no telemetry or tracking. Local inference options are available.

For vulnerability reporting, see SECURITY.md.

Disclaimers

Third-Party AI Services and Libraries

This project integrates third-party AI services and libraries:

  • OpenAI API: Users are required to supply their own API keys and adhere to OpenAI's applicable terms, policies, and API documentation.
  • ONNX Runtime GenAI: Used for local ONNX model inference. More info: onnxruntime-genai
  • llama.cpp: Used for local GGUF model inference via llama-cpp-python.
  • NVIDIA NeMo-Speech.cpp and MagpieTTS: Used for local speech synthesis. See Text-to-Speech third-party notices for runtime, model, and audio-library licenses.

Notolog is developed independently and is not affiliated with or endorsed by these organizations or projects.

  • Compliance: Users are responsible for ensuring their use complies with applicable laws and regulations.
  • Liability: The developers disclaim liability for misuse or non-compliance with legal or regulatory requirements.
  • Trademarks: All trademarks and brand names are the property of their respective owners and are used for identification purposes only.

⭐ If you find Notolog useful, please consider giving it a star on GitHub!


This README.md file has been crafted and edited using Notolog Editor.

Metadata

Release files for notolog 1.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for notolog 1.2.4
File Size Uploaded Provenance Actions
notolog-1.2.4.tar.gz 6.1 MB Without provenance Details for notolog-1.2.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for notolog 1.2.4
File Interpreter ABI Platform Actions
notolog-1.2.4-py3-none-any.whl Python 3 none any Details for notolog-1.2.4-py3-none-any.whl

Total release size: 7.3 MB

Release files / notolog-1.2.4.tar.gz

Download URL notolog-1.2.4.tar.gz
Size 6.1 MB
Tags Source
SHA-256 checksum
How to use checksums
65d3468547785cbac92b8b2db25240f85e63fdec785a4d05837baf51b5d8a053
BLAKE2b-256 checksum
How to use checksums
755e29a518db1e60c237f57951acd05c5d93093166be669a06770f381365e045
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / notolog-1.2.4-py3-none-any.whl

Download URL notolog-1.2.4-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
949d478a9b4c0d0d0d9b107d56f72f1b96d793da17440502b809e2d85eebfe6b
BLAKE2b-256 checksum
How to use checksums
91f8b8adeb47fc1488ac6060029a5904f227043b5e944f43f7bc54d6e5f77c9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for notolog 1.2.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.2.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page