falk-werner / note.py Goto Github PK

Platform: Windows 10, 64-Bit

When switching from Edit to View tab, note.py crashes on Windows. There is a (closed) bug report describing a similar issue for TkinterWeb. We seem to have the same combination here:
TkinterWeb + ttk.Notebook + tk.Text

References:

• Tkinter GUI crash on implementatin of HTMLFrame

In order to organize the attachments of notes, e.g. screenshots or files, it should be possible to open the attachments of a note in file explorer.

First, this project is really great ngl
I checked it out and I wrote "### Hello" to test, when I took focus on "View" tab, it crashed...

Exception in Tkinter callback
Traceback (most recent call last):
  File "C:\Program Files\Python311\Lib\tkinter\__init__.py", line 1948, in __call__
    return self.func(*args)
           ^^^^^^^^^^^^^^^^
  File "C:\Users\Administrator\Downloads\note.py", line 374, in <lambda>
    self.text.bind('<KeyRelease>', lambda e: self.update_view())
                                             ^^^^^^^^^^^^^^^^^^
  File "C:\Users\Administrator\Downloads\note.py", line 387, in update_view
    self.frame.add_css(self.nore.css())
                       ^^^^^^^^^
AttributeError: 'NoteFrame' object has no attribute 'nore'

Our primary development environment is linux. Our github workflows are linux-based too.
Since we have users that run Windows (see Issue #20), we should evaluate how to create workflows for windows in order to get issues with this platform early in our development process.

If the name of a note includes a slash '/' an exception is thrown, when trying to change to an other note.

To Reproduce
Steps to reproduce the behavior:

1. Create a new note
2. Include ' / ' in the name
3. Save the note
4. Try to switch to an other note

Expected behavior
The other note is shown.

Screenshots

Environment (please complete the following information):

• OS: Linux
• Python-Version: Python 3.8.10
• note.py Version: master

Since we only scan for some linux tools to take screenshots, note.py is not able to take screenshots when running on Windows.
We should find a way to fix this gap.

It would be nice to save the geometry (window width and height) on shutdown in order to restore the window in the preferred size on next startup.

We should provide some source code documentation. Sphinx might be a tool to generate this. But we need to provide more detailled documentation within our code comments to get something useful.

We should improve out unit test coverage.
(It there a common way to measure test coverage in Python project?)

We should evaluate some tools for UI testing.
In contrast to some early ideas, we did not manage to separate UI and program logic very well. Therefore, we should add some UI testing framework to automate common use cases.

Ideally, we can add a github workflow for those automated tests. But I'm not sure if this works.
(Do we need to run our workflow headless? Can tkinter application even be run headless?)

In order to filter and categorize notes, it should be possible to add user defined tags to existing notes.

To make devolpemnt more comfortable, a graphical tool (glyphpicker) should be added to select and edit glyphs.

Is your feature request related to a problem? Please describe.
note.py organized it's notes in separate directories, so that the note and all referenced data (e.g. images) are put together. This makes it easy to share note beween different environments via git. Since README.md is a defacto standard that is presented by graphical frontends, the name of the notes file should be README.md.

Describe the solution you'd like
Rename the default note file name to README.md

Describe alternatives you've considered
n.a.

Additional context
The change should be compatible: existing note repositories should be updated on the fly without bothering the user.