|
1 | 1 | # note.py |
2 | 2 |
|
3 | | -Yet another note taking app. |
| 3 | +[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. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +`note.py` has two operation modes: |
| 8 | + |
| 9 | +- **View mode*** to view existing notes |
| 10 | +- **Edit mode** to edit new or alter existing notes |
| 11 | + |
| 12 | +You can switch between the to modes using tabs. |
| 13 | + |
| 14 | +### View Mode |
4 | 15 |
|
5 | 16 |  |
6 | 17 |
|
| 18 | +In `View mode` you can browse, filter and view existing notes. |
| 19 | + |
| 20 | +### Edit Mode |
| 21 | + |
7 | 22 |  |
8 | 23 |
|
| 24 | +In `Edit mode` you can create new notes or edit existing ones. |
| 25 | + |
| 26 | +### Full Feature List |
| 27 | + |
| 28 | +- create notes using markdown |
| 29 | +- filter existing notes |
| 30 | +- rename exsiting notes |
| 31 | +- insert screenshots |
| 32 | +- remove existing notes |
| 33 | +- customize view using CSS |
| 34 | + |
| 35 | +## Accelerators |
| 36 | + |
| 37 | +There are some key bindings to speed up some tasks: |
| 38 | + |
| 39 | +| Key Binding | Description | |
| 40 | +| ----------- | ----------- | |
| 41 | +| Ctrl + n | Create a new note | |
| 42 | +| Ctrl + s | Sync changes _(note that changes are also saved automatically)_| |
| 43 | +| Ctrl + p | Create screenshot | |
| 44 | +| Ctrl + q | Qiut | |
| 45 | + |
| 46 | +## Customize View |
| 47 | + |
| 48 | +You can customize the vie 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. |
| 49 | + |
| 50 | +## Under the hood |
| 51 | + |
| 52 | +All notes manages 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. |
| 53 | + |
| 54 | +## Requirements |
| 55 | + |
| 56 | +`note.py` runs on Python 3. |
| 57 | + |
| 58 | +In order to run `note.py`, the following python modules should be installed: |
| 59 | + |
| 60 | +- tkinter |
| 61 | +- tkinter-tooltip |
| 62 | +- tkinterweb |
| 63 | +- Pillow |
| 64 | +- Markdown |
| 65 | + |
| 66 | +You can installe these modules using the [requiremnts.txt](requirements.txt) file provided in this repository. |
| 67 | + |
| 68 | + pip install -r requirements.txt |
9 | 69 |
|
| 70 | +In oder to create screenshots, [gnome-screenshot](https://linux.die.net/man/1/gnome-screenshot) has the be installed on the system. |
10 | 71 |
|
11 | | -## 3rd Party |
| 72 | +## Other 3rd party stuff |
12 | 73 |
|
13 | 74 | - Icons are used from [https://icofont.com/](https://icofont.com/) |
14 | 75 | _(see [license agreement](https://icofont.com/license))_ |
0 commit comments