datalordstephen / notes-cli-app

This is an basic CLI application that makes request to a server running on localhost with some dummy data.

Notes CLI app

This is an basic CLI application that makes calls to an API running on localhost with some dummy data.

I created the API using FastAPI, and I consumed it using the in-built requests library

To run this project locally, you need to have python installed.

Prerequisites

You need to have git inistalled to clone the repository

To clone the repo, run

git clone https://github.com/datalordstephen/notes-cli-app.git

To change directory, run

cd notes-cli-app

There are 2 versions of this app.

For notes.py, I made use of the inbuilt argparse library to parse arguments from the command line.

For fire-notes.py, i made use of the fire library.

Installing Dependencies

To install the needed packages, run

pip install -r requirements.txt

Running the project

The server needs to be run first. To do that, run

uvicorn notes-api:app

Usage

The CLI tool can carry out 4 operations: fetch all notes, create a new note, update an existing note, and delete a note.

• To fetch all dummy notes, run

py notes.py fetch-notes

• To create a new note, run

py notes.py create-note "content"

Where "content" should be the content of the note to be created.

• To update an existing note, run

py notes.py update-note <note-id> "note-content"

Where <id> is the unique id of the note you want to update

• To delete a note, run

py notes.py delete-note <id>

Where id is the unique id of the note to be deleted.

Note: The same commands can be used to run the fire-notes.py file