Skip to main content

Take notes directly in your terminal.

Project description

notes-cli

A Python based CLI for taking notes from your terminal.

This application was built using Click, which is a wonderful Python package for building interactive CLIs.

Help Page Screenshot

Installation

PIP

We're published to PyPI, which means you can install this package directly through Pip.

pip install py-notes

Local

You must first clone this repository with: git clone https://github.com/Saakshaat/notes-cli

Then, after cding into its directory, install the executable on your system with: pip install --editable .

If you don't want to have this installed globally, you can run it in a virtual environment. To create a virtual env, go to the repo's directory and on the top-level run

  • virtualenv venv
  • . venv/bin/activate
  • pip install --editable .

Running

After installing the CLI successfully, you can run it from whichever environment you installed it in with

notes <command>

show command demo

The application uses a SQLite database to save notes in memory and maintains a threshold of (currently) 25 notes.

When the total number of notes reaches the threshold, it deletes the oldest note in memory before adding the new note.

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

py-notes-1.0.4.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

py_notes-1.0.4-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file py-notes-1.0.4.tar.gz.

File metadata

  • Download URL: py-notes-1.0.4.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.6 Darwin/19.6.0

File hashes

Hashes for py-notes-1.0.4.tar.gz
Algorithm Hash digest
SHA256 89eeac1b56208d4917a780e81bccaeaab74f882c4cf2decf7872a590885cee64
MD5 74ed68f6fe76e20ce7f95232590c51d2
BLAKE2b-256 68f2e47e0194435434b2cd65eef97a3e8bc3eb7899ba5992810424f60de0c2ad

See more details on using hashes here.

File details

Details for the file py_notes-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: py_notes-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.8.6 Darwin/19.6.0

File hashes

Hashes for py_notes-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 80eb68e26cc025ca60908356416b48aee272e01c878b976ebf8ec4265f4d613e
MD5 43149ff4cc3695ad9567ec67fbfa590b
BLAKE2b-256 58ced9a2285286e4e68cda1f560d1dbbd1b2486641fe091124832e985039f726

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