A simple terminal note taking application using Python
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Results
.gitignore
LICENSE
NoteTakingApp.py
README.md
ScheduleEmail.py
Schedules.txt
SendMail.py
requirements.txt
schema_mysql.sql
schema_postgresql.sql
schema_sqlite.sql

README.md

A-Simple-Note-Taking-Terminal-App

A simple terminal note taking application using Python

Python

Features:

  • Simple command line application.
  • Easy to install and very easy to use.
  • Written in simple Python. Even a beginner Python developer can contribute to this.
  • Support for MySQL/SQLite/Postgresql, so you can easily play with it.

Requirements:

  • Execute the following command to install the required third party libraries:
    pip3 install -r requirements.txt

  • For sending emails you will need the built-in smtplib

  • For scheduling emails, you will need to assign the schedule using Crontabs. You can do it manually, but I had used Python-Crontab module to do the job. You can install by:
    pip3 install python-crontab

  • For sending mails via Python, you will first have to change Gmail settings to receive mails via Python. This can be done by visiting the following url and turning the option on: https://myaccount.google.com/lesssecureapps?pli=1

Procedure:

  1. First and the most important step is to create a database for storing our notes. I have used MySQL due to its simplicity, but you can use any database you are comfortable. Just ensure to change the code accordingly. For creating our table, first make a database and then just copy and paste the following schema. This will create a table named notes in your database. You can find the schema here
CREATE TABLE `notes` (
`id` INTEGER NOT NULL AUTO_INCREMENT PRIMARY KEY,
`created` TIMESTAMP DEFAULT '0000-00-00 00:00:00',
`updated` TIMESTAMP DEFAULT now() ON UPDATE now(),
`note` VARCHAR(255),
`tags` VARCHAR(200)
);

If you are using SQLite/ Postgresql, no need of manual configuration. Creation of DB and its configuration will be done automatically using the code itself.

  1. If you want to use the email feature, you will have to run the ScheduleEmail.py file (You will have to run this file only at the beginning.). This file will ask you for your password of your Email ID (Password is saved in the file password.txt in the encrypted form). Also, this file will set the Cron Job to check the time after every single minute. When the date and time matches the one from the Schedules.txt file, you will get a reminder in the form of mail.

  2. Else, you can simply run the NoteTakingApp.py file. This app provides following options:

Options Description
-a 'New Note in Quotes' 'Tag in Quotes' Adds a new note to the Database
-r To read all the notes from the database
-rc To read all the notes from the database (One by one)
-u [id] 'Updated Note in quotes' Updates an already stored note in the database based on id
-d [id] Deletes a specific note based on its id
-ut [id] 'Updated Tag in Quotes' Updates an already existing tag of a note
-rt Read all the distinct tags from the database
-st 'Tag with which note is to be searched in Quotes' Search notes using tags
--reminder 'Note in Quotes' 'Date(dd-mm-yyyy) [SPACE] Time(hh:ss)' This will set a reminder which will send an email at the specified time and day

Built with ♥ by Omkar Pathak

Donation

If you have found my softwares to be of any use to you, do consider helping me pay my internet bills. This would encourage me to create many such softwares :)

PayPal Donate via PayPal!
₹ (INR) Donate via Instamojo