Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

A rudimentary CLI to write and organize text

Project description

# snote

[![Build Status](https://travis-ci.org/nicolemon/snote.svg?branch=master)](https://travis-ci.org/nicolemon/snote)

Rudimentary CLI to write and organize text.

I've got a ways to go in terms of features and documentation. Pull requests are
neat.

## Install

Downloading the repo and firing off `python setup.py install` does the trick.

## Configuration

Reads configuration from whichever file to which environment variable `SNOTE`
points.

Each notebook requires a valid path, where notes will be saved. Global settings
apply to all notebooks, and may be overwritten at a notebook level.

[global]
editor=vim
ext=md
datefmt=%Y-%m-%d
timefmt=%H:%M:%S
timestamp=[{time}]
template=/path/to/template/file
default_title='no title'

[my-notebook]
path=/path/to/directory

[another]
path=/path/to/another/directory
editor=nano
ext=rst

## Usage

usage: snote [-h] [-t] [-f FILENAME]
notebook {update,u,new,n,list,l,ls,search,s} ...

positional arguments:
notebook name of notebook to access

optional arguments:
-h, --help show this help message and exit
-t, --timestamp add a timestamp to the note
-f FILENAME, --filename FILENAME
name a new note, or search for a note to update

actions:
{update,u,new,n,list,l,ls,search,s}
notebook action, defaults to update
update (u) edit note; default action
new (n) create new note
list (l, ls) list note titles in notebook
search (s) list note titles containing the search term

## Motivaton

I wrote this for myself as a way to catalog my stream of consciousness, and an
exercise in packaging.


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
snotebook-0.2.2-py3-none-any.whl (7.6 kB) Copy SHA256 hash SHA256 Wheel py3
snotebook-0.2.2.tar.gz (6.4 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