Scrawl
A python based note-taking console app
"Scrawl" - write (something) in a hurried, careless way.
1. Installation
Prerequisites:
- Python
- supports both 2 and 3
- Python pip module
Recommended / Optional:
- virtualenv to isolate the project
Steps to get scrawling:
- [optional] create a virtualenv and activate it
- On the console :
-
pip install scrawl
That's it !!
2.Usage:
Once installed, scrawl exposes two interfaces to be used in issuing commands:
1. $ scrawl
2. $ scrawl2
1. scrwal:
| Command | Use | Arguments | Options |
|---|---|---|---|
| createnote | Command to create a note | content | |
| viewnote | view a specific note | note id | |
| listnotes | view/display notes | --limit display notes in sets of --limit | |
| searchnotes | search notes | --limit display search result in sets of --limit | |
| export | export notes | [filename] | [--csv] |
| importnotes | import notes | [path] | |
| sync | sync notes with firebase |
all commands provide help on how there are be used. Just issue scrawl {command} --help
2. scrawl2 :
why scrawl2 ? scrwal2 delivers same functionality as scrawl above but with:
- better UI
- Command results, prompts and notifications are displayed in colorful manner as opposed to monochrome
- addedd functionality tabulated below:
| Command | New Arguments & why | New Options & why |
|---|---|---|
| createnote | - | [--title] : a note should be titled. [--noeditor : ability to use editor or not. default = editor] |
| viewnote | ||
| listnotes | ||
| searchnotes |
[--field] - to specify field to query - title or content
highlights the queried string |
|
| export | [filename] | [--csv] |
| importnotes | [path] | |
| sync | Progress bars |
