Git Product home page Git Product logo

cup's Introduction

โ˜• cup

A simple note manager for command-liners.

It's a project still in development and it is yet to mature, so feel free to leave your comments.

Getting started

cup does not requires installation or additional requirements and it works out-of-the-box.

How to use it

The human whose name is written on this note shall... have a coffee?

Basic commands

Running cup without arguments will show your saved notes or help you to create your first note.

Creating a new note is as easy as cup add [your note]. This is the simplest way to work with cup. You can also provide a title with -t.

~$ python3 cup.py add "This looks like an article!" -t "First blog post"
Note created.

(1) 2022-01-26 - First blog post

You can also add a multiline text by pressing Enter or Return in the terminal after a open quotation mark.

~$ python3 cup.py add "The moth don't care
> when he
> sees the flame"

To read, edit and delete a note, cup uses console-friendly words such as cat, ed and rm, respectively.

~$ cup.py cat 1

First blog post
---------------
This looks like an article!

Last updated: 2022-01-26, 18:13.

What it eats

cup uses a JSON file to store notes that looks like this:

{
	"notebook": "main",
	"last_updated": 20220126141024,
	"path": "path/to/notes.json",
	"notes": [
		{
			"id": 1,
			"created": 20220126141024,
			"title": "Example", 
			"content": "First note"
		}
	]
}

To-do

  • Add support to create and switch notebooks
  • Add support for to-do lists
  • Add support for text files

cup's People

Contributors

artrabelo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.