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.3.tar.gz (5.8 kB view hashes)

Uploaded Source

Built Distribution

py_notes-1.0.3-py3-none-any.whl (6.2 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