Git Product home page Git Product logo

daily-diary's Introduction

Daily Journal

daily.py is a command-line utility for managing a daily journal. It provides several functionalities such as creating a new entry, adding to an existing entry, wrapping text, and opening the journal in an editor.

Installation

daily-diary currently requires python3.10 or higher. The reasoning for this is silly, and should change, I think. I'll get to it eventually.

I recommend installing with pipx. You can run the same command with pip instead.

pipx install daily-diary

Currently there is no way to configure the location of your diary, it will go in ~/notes/daily/.

Usage

You can use the daily.py script from the command line as follows:

python daily.py [command] [options]

The available commands are:

  • write: Write an entry to today's file, create it if not exists.
  • add: Add an entry inline. Requires the -m/--mood and -e/--entry options.
  • edit: Edit today's entry without adding any headers.

for any command:

  • -w/--wrap-file: Wrap the entire contents of today's file after editing.

For the add command, these are required:

  • -m/--mood: The mood character and word(s) to be included, like + motivated joyous
  • -e/--entry: The text to be entered into your diary.

Contributing

To install the dev branch, I recommend using pip install -e . in the repository dir.

This is the first repository I am creating with the intent of inviting contributions and turning into a proper package. Please feel free to suggest features, make PRs, or report bugs as you see fit.

I will also accept suggestions on how best to accept suggestions...

License

This project is licensed under the GPLv3 License.

daily-diary's People

Contributors

contrick64 avatar

Stargazers

 avatar

Watchers

 avatar

daily-diary's Issues

'daily add' command doesn't work

Terminal input
daily add -m + happy -e "Had a good day"

Expected Markdown Output

# 2024-04-28 daily log

## 09:44 PM + (happy)
Had a good day

Actual Markdown Output

# 2024-04-28 daily log

## 09:44 PM o ()
E

Debug Info
OS: MacOS 14.4.1
Python Version: 3.11.4

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.