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]"
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)
- 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.10–3.14 (python.org)
- 4 GB RAM minimum (8+ GB for local AI models)
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.
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: No telemetry or tracking. Local-only AI inference options 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.
Notolog is developed independently and is not affiliated with 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.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| notolog-1.2.2.tar.gz | 5.9 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| notolog-1.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 7.0 MB
Release files / notolog-1.2.2.tar.gz
| Download URL | notolog-1.2.2.tar.gz |
|---|---|
| Size | 5.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9ebaa227e9633d61c09dd8b03eeaf02a6abbf0ba3e377e88743109a1fe6ec46a
|
|
BLAKE2b-256 checksum How to use checksums |
ebbe375b770b0bd32b485645d72aead86100c3cab9364391bd36a0c93521cde8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|
Release files / notolog-1.2.2-py3-none-any.whl
| Download URL | notolog-1.2.2-py3-none-any.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4a0cf554d438659addceb9aa91c14d689b7adc0998f49b1fa9ae65acf443be76
|
|
BLAKE2b-256 checksum How to use checksums |
b16aa72384c4f07411d14411d5389c642dadf2926e88832a8f8104db5ed9cf0f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.4
|