Skip to main content

NoteSH fully functional sticky notes App in your Terminal!

Project description

📝 NoteSH

Fully functional sticky notes App in your Terminal! Built with Textual, an amazing TUI framework!

In last Update - Change Background Color

  • You can change background color now!
  • JSON is saved with indent
  • Focus bug fixes
  • Fixed bug that you can't create new Note with some key bindings if there is no notes yet

Installation

Best option to install is using pipx:

pipx install notesh
# but it is still possible to do it with just pip:
pip install notesh

Usage

To start using just type in your terminal:

notesh

it will create new file notes.json in current directory. You can also specify file by using -f flag:

notesh -f MyNotes.json
# or full/relative path
notesh -f ~/Documents/MyNotes.json

➕ Create new Note

  • To create new note just press Ctrl+A
  • You can change color with buttons but also using scroll
  • To edit note just click in its body

New note

🧅 It supports layers

  • To move note grab it top part and move with mouse

Layers

🗚 You can resize notes

  • To resize grab left bottom corner and move with mouse

Resize Notes

💡 And background is resizable

  • If you make make background to big it will readjust after you reopen App
  • You can also click CTRL-Mouse to look around whole wall

Resize Background

💡 Highlight when mouse is over

Resize Background

➕ New Drawable that support borders change

Resize Background

⌨️ Vim/Custom key bindings

You can now do everything using KEYBOARD! This is first version so if you have any suggestions please write them in existing issue.
Default keybindings are in default_bindings.toml file that is in root of installation.
You can also create second file user_bindings.toml where you can overwrite defaults.

What you can do

  • Change focus focus_next/focus_previous using ctrl+i,ctrl+j/ctrl+o,ctrl+k
  • Edit note edit using i
  • When note is focused you can move it with j/k/l/h. Also adding shift moves it more with one click
  • Clicking unfocus using escape returns from edit mode, and unfocus drawable if not in edit mode.
  • Resize note using +/- for vertical and >/< for horizontal
  • Bring 'ctrl+f' Forward and ctrl+b Backward Note

Bindings file

Default file
# These are default, they also are displayed at the footer
[default]
quit = ["ctrl+q,ctrl+c", "Quit"]
toggle_sidebar_left = ["ctrl+e", "Sidebar Left"]
add_note = ["ctrl+a", "Create Stick Note"]
add_box = ["ctrl+x", "Create Box"]
save_notes = ["ctrl+s", "Save Notes"]
unfocus = ["escape", "Unfocus"]
"app.toggle_dark" = ["ctrl+t", "Dark/Light"]

[moving_drawables]
# Default movement
left = "h"
right = "l"
up = "k"
down = "j"
# You can add number after _ and it will move note that many times
left_5 = "H"
right_5 = "L"
up_5 = "K"
down_5 = "J"

[normal_insert]
# there is only `next` and `previous` and the order is not changable yet
focus_next = "ctrl+i,ctrl+j"
focus_previous = "ctrl+o,ctrl+k"
unfocus = "escape"

[normal]
edit = "i"
delete = "Q"
add_note = "o"
add_box = "O"

# For special characters like `+` or `<` you need to use names
# You can check the name using textual `textual keys`
[resize_drawable]
h_plus = "greater_than_sign"
h_minus = "less_than_sign"
v_plus = "plus"
v_minus = "minus"

# It brings at the top or bottom the note
[bring_drawable]
forward = "ctrl+f"
backward = "ctrl+b"

NEW FEATURES

Change Background Color in Left Sidebar

By default you can use ctrl+e to open Left Slidebar:

New note

TODO

There are many thigs to add! If you have idea, please create Issue with your suggestions.

  • Safe saving (now if there are any bugs you may lost your notes)
  • Vim Key bindings
    • Wait for feedback
  • Duplicate Note
  • Hiding menu (Color Picker etc.)
  • TOML config file
  • Left Sidebar (for background and preferences)
    • Background color
  • Align tool for text
  • Fixed layers (if needed)
  • Diffrent Drawables:
    • Check List
    • Arrows

and also resolve problems:

  • Multiline Input (currently textual does not support it and here we have my hacky solution)

Thanks

Big thanks to Will McGugan and all members and contributors of Textualize.io! Go checkout Textual amazing TUI framework on which this app is based.

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

Notesh-0.7.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

Notesh-0.7-py3-none-any.whl (25.1 kB view details)

Uploaded Python 3

File details

Details for the file Notesh-0.7.tar.gz.

File metadata

  • Download URL: Notesh-0.7.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for Notesh-0.7.tar.gz
Algorithm Hash digest
SHA256 8de058db53e212f9052ddd9ef91928d4df539360f4ddee499c17e898dc36b63d
MD5 1c994bbc6a47b08a46fb3a19c3649ec9
BLAKE2b-256 ff42442de287ca464f4881bc135f1da2265ede685ffe61c21b30c340d8a67c52

See more details on using hashes here.

File details

Details for the file Notesh-0.7-py3-none-any.whl.

File metadata

  • Download URL: Notesh-0.7-py3-none-any.whl
  • Upload date:
  • Size: 25.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.9

File hashes

Hashes for Notesh-0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8e357daa1f77a1e90f5db340ba3637f7a0d881ec69a0d9c8a7ed0e57353838e4
MD5 b5d67aaacbf94574f7c727b4c837ab91
BLAKE2b-256 62c777b25db5dc787b1f40a77c989e219df3f616b520498c417dca03ae7f04ab

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page