Skip to main content

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.

Source Distribution

snotebook-0.2.1.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

snotebook-0.2.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file snotebook-0.2.1.tar.gz.

File metadata

  • Download URL: snotebook-0.2.1.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for snotebook-0.2.1.tar.gz
Algorithm Hash digest
SHA256 ee5354100e98de673e5299ef47c27e9b8f7940c06fa37e598970ce939e6a1bbd
MD5 e33759827a248c097e7d63ef21140bf6
BLAKE2b-256 2bb58964ebcd62f51c0ce8944dbddad3f3a025ea8e205efa0297b349dce029b8

See more details on using hashes here.

File details

Details for the file snotebook-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for snotebook-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0cab9534e513e6370af39fd11714c70876923d9124f48702067150ab295e135c
MD5 d379c9db6fcae3b8ff0901343281a480
BLAKE2b-256 05e4f2c95761fdb3d40a5926cee22b0582a45510e00036b5ad60d0764fbb0e4c

See more details on using hashes here.

Supported by

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