https://github.com/falk-werner/note.py

Yet another note taking app
https://github.com/falk-werner/note.py

Last synced: 2 months ago
JSON representation

Yet another note taking app

• Host: GitHub
• URL: https://github.com/falk-werner/note.py
• Owner: falk-werner
• License: mpl-2.0
• Created: 2022-12-16T08:41:29.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-11T13:44:03.000Z (about 1 year ago)
• Last Synced: 2024-12-13T19:24:43.604Z (about 1 year ago)
• Language: Python
• Size: 809 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE
  • Security: SECURITY.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
[![PyPI - Version](https://img.shields.io/pypi/v/note.py-gui)](https://pypi.org/project/note.py-gui)

[![build](https://github.com/falk-werner/note.py/actions/workflows/build.yml/badge.svg)](https://github.com/falk-werner/note.py/actions/workflows/build.yml)

[![GitHub Pages](https://github.com/falk-werner/note.py/actions/workflows/pages.yml/badge.svg)](https://falk-werner.github.io/note.py/index.html)

# note.py

[note.py](https://github.com/falk-werner/note.py) is yet another note taking app. It is aimed to be minimalistic and is shipped as a single python file.

## Features

`note.py` has two operation modes:

- **View mode** to view existing notes

- **Edit mode** to edit new or alter existing notes

You can switch between the two modes using tabs.

### View Mode

![UI view](doc/ui_view.png)

In `View mode` you can browse, filter and view existing notes.

### Edit Mode

![UI edit](doc/ui_edit.png)

In `Edit mode` you can create new notes or edit existing ones.

### Full Feature List

- create notes using markdown

- filter existing notes

- rename exsiting notes

- insert screenshots

- remove existing notes

- customize view using CSS

## Accelerators

There are some key bindings to speed up some tasks:

| Key Binding | Description |

| ----------- | ----------- |

| Ctrl + n    | Create a new note |

| Ctrl + d    | Delete selected note |

| Ctrl + s    | Sync changes _(note that changes are also saved automatically)_|

| Ctrl + b    | Browse attachments |

| Ctrl + p    | Create screenshot |

| Ctrl + q    | Quit |

| Ctrl + e    | Toggle between View and Edit |

| Ctrl + f    | Set focus on filter element |

## Customize View

You can customize the view using CSS. Therefore, just edit the file `$HOME/.notepy/style.css` as desired. To return to defaults, simply delete this file as `note.py` will re-create it during the next start.

## Under the hood

All notes managed by `note.py` are stored in the directory `$HOME/.notepy/notes`. There is a directory for each note according to the notes name. Each note has a file `note.md` containing the contents of the notes. Screenshots are also stored in the note directory.

There is also a central configuration file `$HOME/.notepy.yml` containing

some basic settings.

## Requirements

`note.py` runs on Python 3.

In order to run `note.py`, the following python modules should be installed:

- tkinter

- tkinter-tooltip

- tkinterweb

- ttkthemes

- Pillow

- pyyaml

- cmarkgfm

You can install these modules using the [requirements.txt](requirements.txt) file provided in this repository.

    pip install -r requirements.txt

In oder to create screenshots, [gnome-screenshot](https://linux.die.net/man/1/gnome-screenshot) has to be installed on the system.

## Other 3rd party stuff

- Icons are used from [https://icofont.com/](https://icofont.com/)  

  _(see [license agreement](https://icofont.com/license))_