Skip to main content

A simple CLI Notetaker with magic commands and options for centralization and summaries for teams

Project description

A simple CLI note taker, written in Python.

Home: https://github.com/GitToby/simple_note_taker Pypi: https://pypi.org/project/simple-note-taker/

Features

  • Take notes via CLI and save to a flat json file.
  • Configure tasks and reminders in notes with magic commands such as !task and !reminder.
  • Search your notes with fuzzy matching or exact term matching.

Coming Soon

  • Optionally, share notes with other users via rest of the s3 protocol. Server app coming soon.
  • Summary commands will let you consolidate competed tasks, general notes and other items and share in a verity of methods.

Install

Via pip

pip install simple_note_taker

Usage.

Usage: snt [OPTIONS] COMMAND [ARGS]...

Options:
  --version
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.

  --help                          Show this message and exit.

Commands:
  config     For interacting with configuration tooling
  delete     Delete a note you've taken.
  edit       Edit a note you've taken.
  ls         Fetch the latest notes you've taken.
  mark-done  Mark a task type note as done.
  match      Search your notes you've saved previously which match a search...
  search
  size       Returns details on the size of you notes.
  take       Take a note and save it.
  tasks      Lists notes marked as Tasks.

Dev Setup

Dev with Poetry. Run tests from root with pytest

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

simple_note_taker-0.2.4.tar.gz (17.3 kB view details)

Uploaded Source

Built Distribution

simple_note_taker-0.2.4-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file simple_note_taker-0.2.4.tar.gz.

File metadata

  • Download URL: simple_note_taker-0.2.4.tar.gz
  • Upload date:
  • Size: 17.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.8 Windows/10

File hashes

Hashes for simple_note_taker-0.2.4.tar.gz
Algorithm Hash digest
SHA256 9be1a703651c03966ce4c79c4f20b47b767f28c2671cb4e287683e1cc699dcc1
MD5 435725f293712a9ba8b20c7530d9d0ad
BLAKE2b-256 582c063616fb0a728549ceb0d4a00b2d7d00b36c0a11922f734eabca2d4f795a

See more details on using hashes here.

File details

Details for the file simple_note_taker-0.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for simple_note_taker-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 812e3088f16c29c3c75d8b397822acd1899bff594a3ed4cff36daab922cf3bc1
MD5 38101cc7e9b71d002a3896d982e5f812
BLAKE2b-256 9a73c69f326b9d0be650b45eeab79e02acb44a150feb9df5ac51e6dd2a7ba41d

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