Skip to content
Branch: master
Find file Copy path
Find file Copy path
6 contributors

Users who have contributed to this file

@maebert @MinchinWeb @matze @radomirbosak @dheaney @wren
119 lines (94 sloc) 4.02 KB
#!/usr/bin/env python
# -*- coding: utf-8 -*-
jrnl is a simple journal application for your command line. Journals are stored as human readable plain text files - you can put them into a Dropbox folder for instant syncinc and you can be assured that your journal will still be readable in 2050, when all your fancy iPad journal applications will long be forgotten.
Optionally, your journal can be encrypted using 256-bit AES.
Why keep a journal?
Journals aren't only for 13-year old girls and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't. For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it. For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it.
In a Nutshell
to make a new entry, just type
jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book.
and hit return. yesterday` will be interpreted as a timestamp. Everything until the first sentence mark (.?!) will be interpreted as the title, the rest as the body. In your journal file, the result will look like this:
2012-03-29 09:00 Called in sick.
Used the time to clean the house and spent 4h on writing my book.
If you just call jrnl you will be prompted to compose your entry - but you can also configure jrnl to use your external editor.
* `website & documentation <>`_
* `GitHub Repo <>`_
from setuptools import setup
except ImportError:
from distutils.core import setup
import os
import sys
import re
import readline # NOQA
readline_available = True
except ImportError:
readline_available = False
if sys.argv[-1] == 'publish':
os.system("python sdist upload")
base_dir = os.path.dirname(os.path.abspath(__file__))
def get_version(filename="jrnl/"):
with open(os.path.join(base_dir, filename)) as initfile:
for line in initfile.readlines():
m = re.match("__version__ *= *['\"](.*)['\"]", line)
if m:
conditional_dependencies = {
"pyreadline>=2.0": not readline_available and "win32" in sys.platform,
"readline>=6.2": not readline_available and "win32" not in sys.platform,
"colorama>=0.2.5": "win32" in sys.platform,
"python-dateutil==1.5": sys.version.startswith("2."),
"python-dateutil>=2.2": sys.version.startswith("3."),
description="A command line journal application that stores your journal in a plain text file",
packages=['jrnl', 'jrnl.plugins'],
] + [p for p, cond in conditional_dependencies.items() if cond],
'console_scripts': [
'jrnl = jrnl.cli:run',
'Development Status :: 5 - Production/Stable',
'Environment :: Console',
'Intended Audience :: End Users/Desktop',
'License :: OSI Approved :: MIT License',
'Natural Language :: English',
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 3.7',
'Topic :: Office/Business :: News/Diary',
'Topic :: Text Processing'
# metadata for upload to PyPI
author="Manuel Ebert",
keywords="journal todo todo.txt jrnl".split(),
You can’t perform that action at this time.