Skip to main content

A CLI Journaling that honors your text editor of choice

Project description

Why journ?

journ is a terminal-based journaling app meant to keep you in your terminal. As I've progressed in my development journey, I realized that developers want to stay in their editor/IDE of choice as long as possible. journ is meant to work with your default editor of choice so that you can go from journaling to development all from the ease of the terminal. All while helping you stay accountabile with a daily word goal and streak tracker.

About the Project

journ started as a project to mimic much of the functionality of the website 750words.com but to make the data local for the users instead of in a cloud. It started to feel weird to me with how much personal stuff I was journaling with on a site with a backend that was not in my control.

Since conception of the project, I've deviated a bit from the clone of 750words.com goal and am dedicating myself to a "fully featured" journaling app in the terminal. The core of journ is that I don't want to take your default text editor from you. People who like to do things in their terminal have their editor of choice (I use neovim btw) and so journ defaults to whatever you have it set up as.

It's helpful to have a word counter in your text editor of choice, but journ will take care of that for you if not (just not as elegantly)

The Completion of below will make journ official v1

To Do List

  • Fully implement daily tmp file for editing
  • User login
    • Prevent journaling to anyone logged out
    • Journal Session logging
    • User goals fully implemented
    • Storage of data based on User Login
    • sqlite database uses stored user idea
      • User can update their goals
  • Journaling streak
  • Implement default to user defined text editor
  • Make password optional
  • Add current journ data (word count mostly)

Bug List

  • Changing login system created error when user says they've logged in if db is empty
  • System allows for overwriting of user names
  • Current implementation creates difficult loop if register process starts and user isn't sure they want the selected login, not sure how to fix right now. Will have to replace the recursive calls with while loops.
  • journal sessions are not currently tied to user/any user can access any other users' current journ
  • todays_journ breaks when user hasn't journaled yet
  • Streak incremented multiple times a day
  • Registration followed by journ breaks system
  • other users can still access another's daily journ

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

journ_app-1.0.5.tar.gz (5.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

journ_app-1.0.5-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file journ_app-1.0.5.tar.gz.

File metadata

  • Download URL: journ_app-1.0.5.tar.gz
  • Upload date:
  • Size: 5.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for journ_app-1.0.5.tar.gz
Algorithm Hash digest
SHA256 ffd6bce12a71211f5ae2ee5854e83abc6cb1d017749179042ae17bb7a5d989cb
MD5 9af3d526d10f24980ac24f3634ec22e3
BLAKE2b-256 95b3451936a54f4e293c7df9f77095ef6fde9ed5a5a012a03fc96ba58b90a19a

See more details on using hashes here.

File details

Details for the file journ_app-1.0.5-py3-none-any.whl.

File metadata

  • Download URL: journ_app-1.0.5-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for journ_app-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 38b80f1dba18ca6291e41c7518933d4296777099ba33935c8644380f1a3fc6d7
MD5 bf64b6812a5e1f667bb6a073eb425d5a
BLAKE2b-256 9cfa6bcfa6ddc57982b3f55853769f328dd2f1f5cd8c6295fae4f5e58e94db46

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page