evatlsong / terminal_velocity

Currently in Maintence Mode - A fast note-taking app for the UNIX terminal

Terminal Velocity

Terminal Velocity is currently in maintenance mode. Python pip installs are still supported and the software is stable for day to day use with python 2. The software is being moved into maintenance mode because both authors no longer use terminal_velocity. Life happens and finding the time to maintain it is difficult. We hope you understand.

Terminal Velocity is a fast note-taking app for the UNIX terminal, that focuses on letting you create or find a note as quickly and easily as possible, then uses your $EDITOR to open and edit the note. It is heavily inspired by the OS X app Notational Velocity. For screenshots and features, see the Terminal Velocity website.

Installation

pip - Python package manager

To install Terminal Velocity, run:

pip install terminal_velocity

Then to launch it just run:

terminal_velocity

To use a different notes directory, run:

terminal_velocity path/to/your/notes/dir

To see all the command-line options, run:

terminal_velocity -h

To quit the app, press ctrl-c or ctrl-x.

To upgrade Terminal Velocity to the latest version, run:

pip install --upgrade terminal_velocity

To uninstall it, run:

pip uninstall terminal_velocity

From Source

Ensure python modules urwid, setuptools and chardet are installed. Python-dev also.

apt install python-setuptools python-chardet python-urwid python-dev

Clone the repository from:

[e-mail]:terminal-velocity-notes/terminal_velocity.git
or
https://github.com/terminal-velocity-notes/terminal_velocity.git

Move into terminal_velocity directory you just cloned and run the following:

sudo python setup.py install

Releasing to PyPi

To release a new version of Terminal Velocity:

1. Make sure you have setup your ~/.pypirc file for PyPi uploading
2. Increment the version number in the setup.py file, add an entry te the changelog, commit both changes to git and push them to github. For example, see aae87b.
3. Upload the new release to the terminal_velocity package on pypi: run python setup.py sdist upload -r pypi.

For more information see https://packaging.python.org/.

To contribute code to Terminal Velocity, see CONTRIBUTING.