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.0.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for snotebook-0.2.0.tar.gz
Algorithm Hash digest
SHA256 8ef7077a3cff1fdc6b69d64f6769104dbdb4d216eff4f34e3b9d58937917f5f1
MD5 25db6dd015edd457bac58206988fc447
BLAKE2b-256 bf7b48c66e0b9024d6832defa1db38116fdbb0ab2dd975c8ca8faf921ec05365

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for snotebook-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1c099ac0c9c0f45745d0896307aea499485217e6e84eb385ed24f7ef41c8ac6d
MD5 11067bb8c44e8de672d2f69c7da3efe7
BLAKE2b-256 6a3ab7d75341fed4f0408901211523d11d1fc67d850ffc1814383cf3a58290c1

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