CLI notes manager with tags, colored output, exports and shell autocompletion
Project description
📝 mynotes — jednoduché poznámky v terminálu
Barevné poznámky, tagy, exporty do TXT/MD/PDF a doplňování po stisku
TAB.
🚀 Instalace
1️⃣ Naklonuj nebo rozbal projekt
git clone https://github.com/uzivatel/mynotes.git
cd mynotes
Nebo pokud máš ZIP:
unzip mynotes_project_autocomplete.zip
cd mynotes_project
2️⃣ Nainstaluj lokálně
pip install -e .
To přidá příkaz mynotes do tvého Python prostředí.
💡 Volitelně pro export do PDF:
pip install reportlab
⚙️ Aktivace doplňování (autocomplete)
mynotes používá knihovnu argcomplete, která umožňuje doplňování příkazů a argumentů po stisku TAB.
🐚 Bash
Spusť:
python -m argcomplete.global
To jednou provždy zapne doplňování pro všechny Python CLI nástroje (včetně mynotes).
Pro jistotu obnov shell:
source ~/.bashrc
🌀 Zsh
autoload -U bashcompinit && bashcompinit
eval "$(register-python-argcomplete --shell zsh mynotes)"
Pro trvalé nastavení přidej poslední řádek do ~/.zshrc.
🐟 Fish
register-python-argcomplete --shell fish mynotes | source
Trvale:
register-python-argcomplete --shell fish mynotes > ~/.config/fish/completions/mynotes.fish
⚡ Zkratka my
Chceš psát jen my místo mynotes?
alias my="mynotes"
Trvale:
echo 'alias my="mynotes"' >> ~/.bashrc
source ~/.bashrc
🧠 Základní použití
Přidání poznámky
mynotes add "Koupit mléko"
mynotes add "Dokončit prezentaci" --tags skola fll
Výpis poznámek
mynotes list
mynotes list --tag skola
listzobrazuje přehlednou tabulku s barevnými tagy (přes Rich).
Použij--plainpro obyčejný textový výstup.
Úprava poznámky
mynotes edit 2 --text "Koupit mléko a vejce"
mynotes edit 2 --add-tags ftc --remove-tags skola
Smazání
mynotes delete 1
🏷️ Tagy
Seznam všech tagů
mynotes tag list
Přidání nového tagu
mynotes tag add skola --color bright_blue
Úprava tagu
mynotes tag edit skola --new-name škola --color yellow
Smazání tagu
mynotes tag delete fll
Barvy:
black,red,green,yellow,blue,magenta,cyan,white
- všechny varianty
bright_*
Např.bright_blue,bright_yellow.
Tagy jsou kontrastní:
- světlé barvy → černý text
- tmavé barvy → bílý text
📤 Export
Do textu
mynotes export --format txt --out notes.txt
Do Markdownu
mynotes export --format md --out notes.md --tag ftc
Do PDF
mynotes export --format pdf --out notes.pdf
PDF export používá
reportlab(pokud je nainstalován), jinak se vytvoří jednoduchý PDF soubor bez závislostí.
📦 Kam se ukládají data
- Poznámky:
~/.mynotes.json - Tagy a barvy:
~/.mynotes_tags.json
Chceš uložit jinam?
MYNOTES_PATH=/cesta/notes.json MYNOTES_TAGS_PATH=/cesta/tags.json mynotes list
🧩 Autocomplete v akci
Zkus psát a mačkej TAB:
mynotes [TAB] # → add, list, edit, delete, tag, export
mynotes tag [TAB] # → list, add, edit, delete
mynotes list --tag [TAB] # → nabídne existující tagy
mynotes edit [TAB] # → nabídne ID existujících poznámek
💡 Tipy
mynotes --lje zkratka promynotes listmynotes --a "text"přidá poznámkumynotes --d 3smaže poznámku s ID 3
🧰 Řešení problémů
❌ mynotes: command not found
- Ujisti se, že máš aktivní Python prostředí (např.
venv) - Zkus
pip install -e .znovu - Nebo spusť ručně:
python -m mynotes.cli
❌ Autocompletion nefunguje
- Spusť:
python -m argcomplete.global
- Restartuj terminál nebo proveď
source ~/.bashrc
🎨 Ukázka výpisu
📒 mynotes
┏━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓
┃ ID┃ Poznámka ┃ Tagy ┃ Vytvořeno ┃ Upraveno ┃
┣━━━╋━━━━━━━━━━━━━━━━━━━━╋━━━━━━━━━━━━╋━━━━━━━━━━━━━━╋━━━━━━━━━━━━━━┫
┃ 1 ┃ Koupit mléko ┃ skola fll ┃ před 5 min ┃ - ┃
┃ 2 ┃ Dokončit prezentaci┃ ftc ┃ před 1 h ┃ před 10 min ┃
┗━━━┻━━━━━━━━━━━━━━━━━━━━┻━━━━━━━━━━━━┻━━━━━━━━━━━━━━┻━━━━━━━━━━━━━━┛
Autor
Antonín Šiška
CLI utilita vytvořená v Pythonu pomocí knihoven argparse, rich, argcomplete a reportlab.
Verze: 0.3.0
© 2025 Antonín Šiška
Released under the MIT License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mynotes_cli-0.3.2.tar.gz.
File metadata
- Download URL: mynotes_cli-0.3.2.tar.gz
- Upload date:
- Size: 12.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9d19a9704cecb2bf9fc4c8d2a0913d0456cfc84077f36904b70820cfe6c6c71a
|
|
| MD5 |
45d7eb1592beaa83e44096448b938710
|
|
| BLAKE2b-256 |
5e036b794e4caeadcebb2f31392c42aad0f8021997aef3acf159e630183442b2
|
File details
Details for the file mynotes_cli-0.3.2-py3-none-any.whl.
File metadata
- Download URL: mynotes_cli-0.3.2-py3-none-any.whl
- Upload date:
- Size: 10.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
affb5941c5e5affd7441a54b356e68bc53ef98e01f075e34697b5144501219e0
|
|
| MD5 |
fbccc29a7e02b8d8602271d536d91272
|
|
| BLAKE2b-256 |
8a8d4436de39b18a776689286faa0a7e63215378558432f5dca97fb01ee9937e
|