guilherme-vasconcelos / safenotes

A simple CLI so you can write encrypted notes to self

Safenotes

Work in progress! Safenotes is usable, but has yet to improve!

A program which allows you to write encrypted notes to self.

Where do I begin?

All the Safenotes documentation is available in the docs directory.

It is recommended the you read the documentation in the following order:

1. PREREQUISITES.md
2. INSTALLATION.md
3. USAGE.md

Let me know if anything is missing or incorrect!

License

Safenotes is licensed under the MIT license. Please refer to LICENSE for more details.

safenotes's Issues

Update USAGE.md

Add logs

External commands, creation of new notes and edition should all be logged with the --enable-logs flag (should be disabled by default. This feature will mainly be used for debugging, so it will only be turned on if manually enabled).
Add a --enable-logs flag, which will turn on the logs for that session.

Add to notes menu a button to rename note

Requires #18 because it will use the same menu

Improve documentation

• Add README.md with table of contents to docs directory
• Add examples and screenshots
• Maybe add a contributing guide

Add more colors and enhance style

Currently Colorama is installed, but some things (such as the questionary) cannot be colorized, so it still needs a lot of visual enhancement.

Implement the "Refresh encryptions" option

If the user closes the terminal without quitting Safenotes first, there is a possibility that some notes will be unencrypted.

Because of that, there must be a "Refresh encryptions" option (which already exists, but does nothing), which will go over each file, and if it is not encrypted, encrypt it.

Refactor files

What is there to fix:

• displayer.py: missing docstrings, maybe enhance code quality
• paths.py: paths are of different class

Add a strict mode

Strict mode: password is prompted on every action (e.g. create note, edit note) rather than when lauching safenotes.

Small improvements

• When attempting to delete a note, safenotes should first ask for confirmation
• Add to usage (precautions) a warning regarding file names, and raise error if user tries to create or rename a file to contain the .gpg extension, as it will currently break the is_file_encrypted function
• May not use colors for everything
• Button for unencrypt note
• Button for encrypt note
• Button for unencrypting all notes

Allow script to be run at any directory and without explicitly calling Python

https://python-poetry.org/docs/pyproject/#scripts

Ideal usage example: safenotes instead of python3 safenotes/safenotes.py

Add a way to delete notes

Once note is selected, there should be an option to edit or delete (currently it automatically goes for editing).

Suggestion: once a note is selected, go to another menu (again using the questionary library) with the following contents:

Note: <note_name>
Pick an option:
Edit
Delete
Go back

Remember to update documentation accordingly

Add more CLI flags

• -h / --help
• -v / --version
• -l / --license
• -s / --strict (#29)
• -w / --watch (#8)

Add new data to notes - Creation and due

Besides the public title (which is the file's name), each note should also have:

• Date of creation
• Optional due date

These data should appear when displaying all notes, and they must be stored in ~/.config/Safenotes/data, which will be the file used for storing notes' public information.

Add a watch mode

Requires #2

Watch mode: script runs in background and sends an alert if there is a note close to due date.