Notolog Editor
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
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.
Legal
- 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.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| notolog-1.2.5.tar.gz | 6.1 MB | With provenance | Details for notolog-1.2.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| notolog-1.2.5-py3-none-any.whl | Python 3 | none | any | Details for notolog-1.2.5-py3-none-any.whl |
Total release size: 7.3 MB
Release files / notolog-1.2.5.tar.gz
| Download URL | notolog-1.2.5.tar.gz |
|---|---|
| Size | 6.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b010597d9f300a40fccfc60555c2db924d7541c2f02b221f88477ce086134c3
|
|
BLAKE2b-256 checksum How to use checksums |
a935cebe618aa3fff14a3b9c06505db1585400e33addc8dbdf42b11bb795565a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.
Transparency logRelease files / notolog-1.2.5-py3-none-any.whl
| Download URL | notolog-1.2.5-py3-none-any.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c18266b68294244b8f98df6f396b23951412dec048fa3b16b5ef9bcd901b6d70
|
|
BLAKE2b-256 checksum How to use checksums |
5b2250821614c821e64d53adeeb8e485c42b5c40bc8222db9796759f7a230418
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.
Transparency logSecurity for notolog 1.2.5
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for notolog-1.2.5.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.
Transparency logA 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.