tnote-plus 0.1.0

simple CLI notetaking

tnote

             _________ _        _______ _________ _______       _    
             \__   __/( (    /|(  ___  )\__   __/(  ____ \     ( )   
                ) (   |  \  ( || (   ) |   ) (   | (    \/     | |   
                | |   |   \ | || |   | |   | |   | (__       __| |__ 
                | |   | (\ \) || |   | |   | |   |  __)     (__   __)
                | |   | | \   || |   | |   | |   | (           | |   
                | |   | )  \  || (___) |   | |   | (____/\     | |   
                )_(   |/    )_)(_______)   )_(   (_______/     (_)   
                                                                                    

A dead simple command line note taking app built for you! The original project lives here: https://github.com/tasdikrahman/tnote

At the time of forking the project, there had been not updates in 4 years with 11 issues. I thought it was interesting enough to at least fork it and give it a shot.

Index

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

Features

:arrow_up: 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

NOTE This was built and testing in Linux - use on other OS's at your own risk

• Text Highlighting is cross platform - Supports Linux, Windows, MAC for the terminal based highlighting.
• Searching for notes is hassle free in tnote: 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

:arrow_up: Back to top

If poetry is on the system:

poetry install

Run it

Fire it up! :volcano:

poetry run ./tnote_plus/tnote.py

---

Contributing

:arrow_up: Back to top

This project was originally created in a few hours and utilizes peewee (ORM). It was then forked by acherrera to do more work.

Dependencies

Dependencies are managed with Python Poetry. This is also used to publish the package.

Install poetry with curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python -

Deployment

poetry build will build the project.

poetry publish will publish the package to a repository.

To-do

• Convert color handling to Rich
• Add initial tests
• Add github actions for tests
• Make it pip installable
• Ability to edit the content of a note
• Add option to remove title for notes
• Add option to search for notes using title
• Add option to search for notes using timestamp
• List titles with number and open based on number

Contributers

A big shout out to all the contributers, more specifically to these guys

• OG contributers:

• @maxwellgerber
• @BrandtM

Motivation

:arrow_up: Back to top

Original project had not had updates for 4 years, so I thought I would try my hand at understanding what was going on and expanding upon the project.

---

Issues

:arrow_up: Back to top

You can report the bugs at the issue tracker

---

License

:arrow_up: Back to top

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