wnote 0.5.1

Terminal Note Taking Application with beautiful UI

WNote - Terminal Note Taking Application

WNote is a beautiful and user-friendly CLI note-taking application that runs entirely in the terminal.

Features

• ✏️ Create, edit, view, and delete notes
• 🏷️ Tag notes for better organization
• 🎨 Customize colors for each tag
• 🔍 Filter notes by tags and search content
• 📝 Edit notes with your favorite editor (vim, nano, etc.)
• 📎 Attach files or directories to notes
• 🖥️ Open attachments directly from notes
• 📊 Statistics and note analysis
• ⏰ Reminders for notes
• 📤 Export notes to multiple formats (Markdown, HTML, Text)

Installation

Requirements

• Python 3.7+
• pip

Install from PyPI

pip install wnote

Install from Source

git clone https://github.com/yourusername/wnote.git
cd wnote
pip install -e .

Usage

Basic Commands

• Create a new note:

wnote add "Note Title" -t "tag1,tag2"

• Create a note with attachment:

wnote add "Note Title" -f "/path/to/file"

• Attach file to existing note:

wnote attach 1 "/path/to/file"

• Remove attachment from note:

wnote deattach 1 --attachment-id 1

• View all notes:

wnote show

• View note by ID:

wnote show 1

• View note and open attachments:

wnote show 1 -o

• View notes by tag:

wnote show -t "work"

• Search notes:

wnote search "keyword"

• Edit note content:

wnote edit 1

• Update title or tags:

wnote update 1 -t "new title" --tags "tag1,tag2,tag3"

• Delete note:

wnote delete 1

• Delete tag:

wnote delete tag_name --tag

• View all tags:

wnote tags

• Set tag color:

wnote color work blue

• View configuration:

wnote config

Advanced Features

• Export note to Markdown:

wnote export 1 --format markdown

• Export note to HTML:

wnote export 1 --format html --output note.html

• View statistics:

wnote stats

• Add reminder to note:

wnote reminder 1 "2025-12-31 14:30" "Project deadline"

• View reminders:

wnote reminders

Configuration Paths

• Database: ~/.config/wnote/notes.db
• Config file: ~/.config/wnote/config.json
• Attachments directory: ~/.config/wnote/attachments

Available Colors

• Standard: red, green, blue, yellow, magenta, cyan, white, black
• Bright: bright_red, bright_green, bright_blue, bright_yellow, bright_magenta, bright_cyan, bright_white

Development

Setup Development Environment

1. Clone the repository:

git clone https://github.com/yourusername/wnote.git
cd wnote

2. Create and activate virtual environment:

python -m venv venv
source venv/bin/activate  # Linux/macOS
# or
venv\Scripts\activate  # Windows

3. Install development dependencies:

pip install -e ".[dev]"

Running Tests

pytest

Building Package

python -m build

Publishing to PyPI

1. Update version in pyproject.toml and setup.py
2. Build package:

python -m build

3. Upload to PyPI:

python -m twine upload dist/*

License

Distributed under the MIT License. See LICENSE for more information.

---

WNote - Ứng dụng Ghi chú Terminal

WNote là ứng dụng ghi chú CLI chạy hoàn toàn trên terminal với giao diện đẹp mắt và dễ sử dụng.

Tính năng

• ✏️ Tạo, chỉnh sửa, xem và xóa ghi chú
• 🏷️ Gắn thẻ (tag) cho ghi chú
• 🎨 Tùy chỉnh màu sắc cho từng thẻ
• 🔍 Lọc ghi chú theo thẻ và tìm kiếm nội dung
• 📝 Soạn thảo ghi chú với trình soạn thảo yêu thích của bạn (vim, nano, etc.)
• 📎 Đính kèm file hoặc thư mục vào ghi chú
• 🖥️ Mở file/thư mục đính kèm trực tiếp từ ghi chú
• 📊 Thống kê và phân tích ghi chú
• ⏰ Nhắc nhở cho ghi chú
• 📤 Xuất ghi chú sang nhiều định dạng (Markdown, HTML, Text)

Cài đặt

Yêu cầu

• Python 3.7+
• pip

Cài đặt từ PyPI

pip install wnote

Cài đặt từ Source

git clone https://github.com/yourusername/wnote.git
cd wnote
pip install -e .

Sử dụng

Các lệnh cơ bản

• Tạo ghi chú mới:

wnote add "Tiêu đề ghi chú" -t "tag1,tag2"

• Tạo ghi chú với file đính kèm:

wnote add "Tiêu đề ghi chú" -f "/đường/dẫn/đến/file"

• Đính kèm file vào ghi chú hiện có:

wnote attach 1 "/đường/dẫn/đến/file"

• Bỏ file đính kèm khỏi ghi chú:

wnote deattach 1 --attachment-id 1

• Xem tất cả ghi chú:

wnote show

• Xem ghi chú theo ID:

wnote show 1

• Xem ghi chú theo ID và tự động mở tất cả file đính kèm:

wnote show 1 -o

• Xem ghi chú theo thẻ:

wnote show -t "work"

• Tìm kiếm ghi chú:

wnote search "từ khóa"

• Chỉnh sửa nội dung ghi chú:

wnote edit 1

• Cập nhật tiêu đề hoặc thẻ:

wnote update 1 -t "new title" --tags "tag1,tag2,tag3"

• Xóa ghi chú:

wnote delete 1

• Xóa thẻ:

wnote delete tag_name --tag

• Xem tất cả thẻ:

wnote tags

• Đặt màu cho thẻ:

wnote color work blue

• Xem cấu hình:

wnote config

Các tính năng nâng cao

• Xuất ghi chú sang Markdown:

wnote export 1 --format markdown

• Xuất ghi chú sang HTML:

wnote export 1 --format html --output note.html

• Thống kê ghi chú:

wnote stats

• Thêm nhắc nhở cho ghi chú:

wnote reminder 1 "2025-12-31 14:30" "Deadline cho dự án"

• Xem các nhắc nhở:

wnote reminders

Đường dẫn cấu hình

• Cơ sở dữ liệu: ~/.config/wnote/notes.db
• Tệp cấu hình: ~/.config/wnote/config.json
• Thư mục đính kèm: ~/.config/wnote/attachments

Các màu có sẵn

• Chuẩn: red, green, blue, yellow, magenta, cyan, white, black
• Sáng: bright_red, bright_green, bright_blue, bright_yellow, bright_magenta, bright_cyan, bright_white

Phát triển

Thiết lập môi trường phát triển

1. Clone repository:

git clone https://github.com/yourusername/wnote.git
cd wnote

2. Tạo và kích hoạt môi trường ảo:

python -m venv venv
source venv/bin/activate  # Linux/macOS
# hoặc
venv\Scripts\activate  # Windows

3. Cài đặt các gói phát triển:

pip install -e ".[dev]"

Chạy kiểm thử

pytest

Đóng gói

python -m build

Đăng lên PyPI

1. Cập nhật phiên bản trong pyproject.toml và setup.py
2. Đóng gói:

python -m build

3. Đăng lên PyPI:

python -m twine upload dist/*

Giấy phép

Phân phối dưới giấy phép MIT. Xem LICENSE để biết thêm chi tiết.