Skip to main content

A simple and light-weight notepad for the command line

Project description

sjournal GitHub release (latest SemVer including pre-releases)

A simple and light-weight notepad for the command line:

Demo

Installation

via pip

> git clone https://github.com/SamuelStuver/sjournal.git
> cd sjournal
> pip install -r requirements.txt --user

via pipenv

> git clone https://github.com/SamuelStuver/sjournal.git
> cd sjournal
> pipenv shell
> pipenv install

Set up Cmder alias

In the step blow, replace sjournal= with the name for the alias you want to run sjournal with:

> echo sjournal=python <PATH TO REPO>\sjournal.py $* >> %CMDER_ROOT%\config\user_aliases.cmd

Then, sjournal can be run via alias in the command line:

> sjournal

Set up Windows Cmd alias

In the steps below, replace sjournal in sjournal.bat with the name for the alias you want to run sjournal with:

> cd c:/
> mkdir alias
> cd alias
> echo @echo off >> sjournal.bat
> echo echo. >> sjournal.bat
> echo python <PATH TO REPO>\sjournal.py %* >> sjournal.bat

Finally, add c:/alias to PATH in your system environment variables. Then, sjournal can be run via alias in the command line:

> sjournal

Usage

usage: sjournal.py [-h] {add,backup,categories,delete,edit,erase,help,list,load,restore,search} ...

options:
  -h, --help            show this help message and exit

Commands:
  {add,backup,categories,delete,edit,erase,help,list,load,restore,search}
                        Commands
    add                 Add a note to the database
    backup              Backup the current journal
    categories          List all categories in the current journal
    delete              Delete one or multiple notes from the database
    edit                Edit a note to the database
    erase               Delete all notes from the database
    help                Display help text
    list                List notes in the database
    load                Load a journal or create a new one if it doesn't exist
    restore             Restore the database from a file. If --filename is not given, restore the latest backup
    search              List notes matching search term

 To see help for specific commands, use sjournal.py [COMMAND] --help

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

sjournal-0.2.0.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

sjournal-0.2.0-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sjournal-0.2.0.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.3

File hashes

Hashes for sjournal-0.2.0.tar.gz
Algorithm Hash digest
SHA256 91a20f540d9ca6e9fdff31024cf9ae78e6c4556a4fa9e78f0d25d8f5764f87f0
MD5 5a27a0fef77ad08be77a667819621d6c
BLAKE2b-256 58ed93357210be2b3c7c1ef972a8ef0b9f955a69c3f0f5adba2a8f23bf003861

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sjournal-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.0 importlib-metadata/4.11.3 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.3

File hashes

Hashes for sjournal-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ed82d16f724c2a62d3f6598b07de3f672f0e5553dbe5186ad01789a30355d4d
MD5 dd88cd87608c8bd2c817fb239b5f5155
BLAKE2b-256 e5d1deea50b9c60f3617d259cc31d371226374921ad58acede492f3f963acf27

See more details on using hashes here.

Supported by

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