Skip to main content

Note taking with version control

Project description

Epistle

epistle /ɪˈpɪs(ə)l/ noun formal, humourous - A letter.

Danny

Take ad hoc notes using Vim. Save them in a remote Git repository. This supports sharing notes across devices.

Can be configured to use a private (or public) gist.

Requirements

  • Python 3.6
  • Vim
  • Git

Both Vim and Git must be in your PATH.

Installation

Via PyPI

$ pip install epistle

Or, clone this repo and run pip install directly:

$ git clone git@github.com:msharp/epistle.git
$ pip install epistle/

Usage

Epistle is a command-line tool.

To create a new note:

$ epistle new my_note

This will open Vim, where you can compose the note. After you exit Vim, the note will be saved, added to the repo and pushed to the remote.

The following commands are available:

  • list List available Epistles
  • view View the contents of an Epistle
  • new Create a new Epistle
  • edit Edit an Epistle
  • rename Rename an Epistle
  • delete Delete an Epistle
  • git Run push or pull to the remote Git repository

Run epistle --help to see a list of available commands.

When you first run the epsitle command, it will discover your Vim and ask for the clone URL of the remote repository you want to use.
It will then clone this repository and store the URL in its config.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
epistle-0.2.5.tar.gz (3.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page