A rudimentary CLI to write and organize text
Project description
# snote
[](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.
[](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.2.tar.gz
(6.4 kB
view details)
Built Distribution
File details
Details for the file snotebook-0.2.2.tar.gz
.
File metadata
- Download URL: snotebook-0.2.2.tar.gz
- Upload date:
- Size: 6.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4eee84845b07972a616ac82fd8e7f6f31ebd87a37f501097d511a6aec6b0144e |
|
MD5 | f1312e7ed011e945b74b5a68843fce46 |
|
BLAKE2b-256 | 54662897699a0a3851dcceac1f024740d3552e6713070357593240d388695cfe |
File details
Details for the file snotebook-0.2.2-py3-none-any.whl
.
File metadata
- Download URL: snotebook-0.2.2-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 297c2b4d2175adf433884477d667eef1b1192c29efae9d778b4d7c13753870e2 |
|
MD5 | 8ab67bd2432b848824a9c44f7c06c8c0 |
|
BLAKE2b-256 | 9a1fdc2eed4e38025defde3630b49c8a7e470c9d8d4f6cf12a2f4e940c81ab87 |