Skip to main content

A fast note-taking app for the UNIX terminal

Project description

# Terminal Velocity 2

Terminal Velocity 2 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](http://notational.net/). For screenshots and features, see the [Terminal Velocity website](https://github.com/terminal-velocity-notes/terminal_velocity).

## Installation

### pip - Python package manager To install Terminal Velocity, run:

pip install tv2

Then to launch it just run:

tv2

To use a different notes directory, run:

tv2 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 tv2

To uninstall it, run:

pip uninstall tv2

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

https://github.com/makyo/tv2.git

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

sudo python setup.py install

## Releasing to PyPi

To release a new version of Terminal Velocity 2:

  1. Make sure you have setup your ~/.pypirc file for PyPi uploading

  2. Increment the version number in the [setup.py file](setup.py), add an entry to the [changelog](CHANGELOG.txt), commit both changes to git and push them to github. For example, see [aae87b](https://github.com/seanh/terminal_velocity/commit/aae87bcc50f88037b8fc76c78c0da2086c5e89ae).

  3. Upload the new release to [the tv2 package on pypi](https://pypi.python.org/pypi/tv2): run python setup.py sdist upload -r pypi.

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

To contribute code to Terminal Velocity, see [CONTRIBUTING](https://github.com/makyo/tv2/blob/master/CONTRIBUTING.md#contributing-to-terminal-velocity).

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

tv2-0.2.0.tar.gz (14.7 kB view details)

Uploaded Source

File details

Details for the file tv2-0.2.0.tar.gz.

File metadata

  • Download URL: tv2-0.2.0.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.6

File hashes

Hashes for tv2-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a15b537ca913aa47840bcf4beec538767b280e0b7c231499eb1481fcab1047ca
MD5 3bf87f535ee45fa6edc5faa6fa8a08f9
BLAKE2b-256 8722cc741a5cb7e570da02be6a1fe90bc503f403bfbd5f1cda28b24b7433e60b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page