NOTES

  _   _       _
 | \ | |     | |
 |  \| | ___ | |_ ___  ___
 | . ` |/ _ \| __/ _ \/ __|
 | |\  | (_) | ||  __/\__ \
 |_| \_|\___/ \__\___||___/

A dead simple command line note taking app built for you!

Acknowledgment

Inspired by tnote created by tasdikrahman. Original repo has some bugs, which have been solved in pull requests. However, the author is not responding, so I created my own version of the repo with changes I thought was required.

This notes module supports multi-line support for Content field.

Index

• Demo
• Features
• Installation
  • Installing dependencies
  • Clone it
  • Run it
• Supported platforms
• Contributing
  • To-do
  • Contributers
• Issues
• License
• Donation

Demo

⬆️ Back to top

Watch a live demo of it working here

TODO

---

Features

⬆️ Back to top

• Dead simple to use: Even your granny would be able to use it. No seriously!
• Feature rich Add your precious note with it's title , content , tags
• Secure: Encrypts your database using standard AES-256 in CBC mode. So even if anybody gets hand of your database file. He cannot make any sense of it. A little demo of what I am doing using it

NOTE This feature is available/tested only on linux based systems. Support for other OS's coming soon!

• Text Highlighting is cross platform - Supports Linux, Windows, MAC for the terminal based highlighting.
• Searching for notes is hassle free in notes: It supports full text search for notes based on content, tags
  • The search query if found in the database will be highlighted if found. Looks pleasing to the eyes
• Ability to add and remove tags for each note.
• Adds timestamp for each note which has been added.
• Written in uncomplicated python.

Need I say more?

---

Installation

⬆️ Back to top

Installing dependencies

NOTE

On linux system, install libsqlcipher-dev

$ sudo apt-get install libsqlcipher-dev

On Mac OS systems, you can install it by

$ brew install sqlcipher

Clone it

$ git clone https://github.com/vaulstein/notes
$ cd notes && pip install -r requirements.txt

Add a symbolic link to it

$ chmod +x notes
$ cd ~/bin/ 
$ ln -s ~/some/path/to/notes/notes

Replace ~/some/path/to/notes by the path where you have cloned the repo. For example if you have cloned it to ~/Downloads/notes folder than your command should look something like

$ ln -s ~/Downloads/notes/notes

Add the notes executable at the end of the path.

Run it

Fire it up! 🌋

$ notes

---

Supported platforms

⬆️ Back to top

OS	Support status
Linux	✅ Full support
OS X	✅ Full support
Windows	☑️ encrytion of the Database for windows not yet supported

---

Contributing

⬆️ Back to top

This app was created in a timespan of 2 hours while learning to use peewee (ORM). So don't be shy to make some PR's here 😄

To-do

[x] Added support to add multiple content

• Add unit tests. Like real quick!
• Make it pip installable
• Ability to edit the content of a note
• Add python2 support
• Add tags support for notes
• Remove tags for notes
• Add option to add title for notes
• Add option to remove title for notes
• Add option to search for notes using content
• Add option to search for notes using tags
• Add option to search for notes using title
• Add option to search for notes using timestamp
• Encrypt the .db file using Sqlcipher
• Add colorized text to the notes for improved UI
• Add better UI using urwid

Motivation

⬆️ Back to top

Why not! Cheers to a crazy weekend 😄

---

Issues

⬆️ Back to top

You can report the bugs at the issue tracker

OR

You can tweet me if you can't get it to work. In fact, you should tweet me anyway.

---

License

⬆️ Back to top

You can find a copy of the License at http://prodicus.mit-license.org/

Donation

⬆️ Back to top

Donate to the original developer!

PayPal
Gratipay
Patreon
£ (GBP)
€ Euros
₹ (INR)