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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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