Skip to content

TechWiz-3/happy-jar-cli

Repository files navigation

Happy Jar CLI

An easy to use CLI for storing good memories and gratitiude.

# basic logging
$ happy log "Happy text here! :D"

# view logs with
$ happy get all

# or,
$ happy get today

Installation

pip install happyjar

Binaries:
Download the binary for your platform from the Artifacts section of the latest GitHub Actions run.

What is it?


Source

Usage

$ happy --help
usage: happy [-h] {log,get} ...

Log your good memories and gratitiude.

positional arguments:
  {log,get}
    log       logs an entry
    get       gets entries

optional arguments:
  -h, --help  show this help message and exit

examples:
happy log "i am so happy because you starred this project's repo on github xDD"
happy get all

Example

Inspired by michelle/happy

Todo

Check Issues for more.

Development

  1. Clone the repo and cd into it
  2. Ensure poetry is installed - pip install poetry
  3. Run poetry install
  4. Make whatever changes you need
  5. To text changes run (in project root directory) poetry run happy

Contributors


🎉 Commit labels

If you're interested in the commit labels used in this repo, check out my git commit emoji project