A fast note-taking app for the UNIX terminal, with Git support.
Project description
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.
This is a fork of the original project, which adds the ability to automatically pull and push your Notes changes to a Git project. When you start terminal velocity it will automatically pull from the configured git project, and when you exit it will automatically push.
Installation
pip - Python package manager
To install Terminal Velocity, run:
pip install terminal-velocity-git
Then to launch it just run one of the following commands:
terminal_velocity
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:
git@github.com:vhp/terminal_velocity.git
or
https://github.com/vhp/terminal_velocity.git
Move into terminal_velocity directory you just cloned and run the following:
sudo python setup.py install
Sync your notes to Git
You will need:
A GitHub or GitLab project (for free private projects GitLab is recommended)
The clone URL of the git project
Before setting this up !!take a backup of your existing Notes directory!!.
Create file ~/.git_notes_project.yaml, and add the following:
project url: <git-project-url>
Optionally you can change the directory that terminal-velocity uses for notes by adding the following to the file:
project directory: ~/My-Other-Notes-Directory
Note that this configuration does not affect the terminal velocity configuration, only the Git project management add-on.
When you start terminal-velocity it will automatically initialise the Git project within your Notes directory
Releasing to PyPi
To release a new version of Terminal Velocity:
Make sure you have setup your ~/.pypirc file for PyPi uploading
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.
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/.
Other things
To make a bug report or feature request, use GitHub Issues.
To contribute documentation, use the wiki.
To contribute code to Terminal Velocity, see CONTRIBUTING.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for terminal-velocity-git-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6999771cf69e0ad514c057188bc0d7d1cb3c715d3a98a82c770516b82b9bd98f |
|
MD5 | 25502ce6d1c6127fd68f46a37d1ea269 |
|
BLAKE2b-256 | e617c491a0feb7a47c085223d010040f7e2d79081382d8476753053443d6e5cf |
Hashes for terminal_velocity_git-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fb2ac28417ee481ec49aec063e965fa069e76694bf23d1f837e301fc88e7727 |
|
MD5 | 9e40a640e2d48cdf967636cb39e0203f |
|
BLAKE2b-256 | 79b4537349015b9827e495b21a0c84c66cca1affebd9ae1e3d1bd77299ffece1 |