Metadata-Version: 2.1
Name: snotebook
Version: 0.2.2
Summary: A rudimentary CLI to write and organize text
Home-page: https://github.com/nicolemon/snote
Author: Nicole A Montano
Author-email: n@nicolemon.com
License: MIT
Keywords: cli commandline terminal notes python
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Provides-Extra: test
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'

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


