A VIM-inspired note manager for the console
Project description
Noted
Keep your notes to yourself.
Vision
Free, simple, encrypted note-taking in markdown
Dependencies
- pycrypto
Roadmap
- Package for distribution
- Unopinionated key mappings (non-vim, arrow keys etc.)
- Handle graceful shutdown on SIGTERM
- Save search queries
- List and edit existing tags
Contributing
Setup development environment
- Clone repository
- Setup virtual env and install dependencies:
cd noted-cli
virtualenv env
source env/bin/activate
pip3 install -r requirements.txt
LOGLEVEL=DEBUG python3 noted
Build for distribution
Run ./pack-dist
in the base directory. Built file/files will be located in
dist/
Debugging
You can enable the debug log by launching noted with the environment variable
LOGLEVEL
set to DEBUG
.
Example: LOGLEVEL=DEBUG noted
By default, if LOGFILE
environment variable is not specified, the logging
data will be written to noted.log
in the storage directory $HOME/.noted
.
The default log level is set to WARNING
.
TODO
- Change encryption passphrase.
- Delete tag entity when removing last use of tag from note.
- Rename tags.
- Delete tags.
- Be able to store a search query.
- Be able to initiate the TUI with arguments.
- Tag auto complete when using tag object notation in search field.
- Configure editor (xdg-open?).
- Safer way of opening database/files to increase privacy/security.
Considerations
- Utilize GnuPG for encryption of database and files.
- Break out CLI/TUI version to own project/s
Known bugs/issues
- Cannot edit note on macOS. Issue due to tmpfs removing file before we get the chance to read?
- Log file gets created in cwd.
- Saving an empty note causes SQLite exception.
- Curses doesn't restore terminal after VIM has been opened in some cases (may be caused by some VIM plugin).
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
noted-cli-0.1.4.tar.gz
(27.7 kB
view hashes)
Built Distribution
noted_cli-0.1.4-py3-none-any.whl
(51.9 kB
view hashes)
Close
Hashes for noted_cli-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a8fdbb10b4e3d9c83dd5ef76afcad223a5397c31e19a25b2fd0e1211fdba250 |
|
MD5 | c292585579b95775fc12b6dc62f4a4e3 |
|
BLAKE2b-256 | 5056c43a36cd0be80fa3ec79214cba8990e567fd66ebc399ef1d66044576c3cc |