Skip to main content

App to write journal digitally

Project description


App to write journal digitally.

PyPI version


  • Write your journal using Markdown in your favorite text-editor.
  • Stores written journals in a comprehensive directory structure.
  • View the journals (Markdown rendered in HTML) in browser.


Install it using pip

pip install journalist


sumit at HAL9000 in ~
$ python3 -h
usage: [-h] {write,view} name

positional arguments:
  {write,view}  Task to do
  name          The name of the journal

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

Usage Examples

Writing journal

Journals are stored in the directory ~/.journalist in the following structure.

└── journalname
     └── YYYY
        └── MM

For example, an example ~/.Journalist directory may contain

sumit@HAL9000:pts/0->/home/sumit (0)
> tree .journalist
├── personal
│   ├── 2017
│   │   └── 12
│   │       └──
│   └── 2018
│       └── 01
└── technical
    ├── 2017
    │   └── 12
    │       ├──
    │       └──
    └── 2018
        └── 01

10 directories, 4 files

To write in a the journal personal, type in the following…

sumit at HAL9000 in ~
$ python3 write personal
  • If any journal named personal already exists, it will open up the relevant .md file corresponding to the system date (creating it if it doesn’t exist).
  • If any journal named personal doesn’t exist, it will prompt the user if they want to create a new journal. If they agree, it will do so and open the corresponding .md file as described above.

The markdown file will be opened in the editor mentioned in the config.yaml file (default is nano). If you change it to something else, make sure an file named can be opened using that editor by typing editor in the terminal.

Viewing journal

sumit at HAL9000 in ~
$ python3 view personal
[*] Starting Journalist viewer webapp...
[*] View this journal at
 * Running on (Press CTRL+C to quit)

Opening the URL in the browser would show us the journal entries rendered in HTML.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

journalist-0.0.3.tar.gz (5.6 kB view hashes)

Uploaded source

Built Distribution

journalist-0.0.3-py3-none-any.whl (6.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page