Skip to main content

A command line tool to make a Markdown vault from a Journey export

Project description

journey2md

Introduction

This is a simple command line tool that can be used to extract journal entries from Journey and turn them into a collection of Markdown files. In this tool's case the Markdown collection is built so it can easily be used as an Obsidian Vault.

Installing

[!NOTE] Ignore this section for the moment, this is a placeholder.

pipx

The package can be installed using pipx:

$ pipx install journey2md

Homebrew

The package is available via Homebrew. Use the following commands to install:

$ brew tap davep/homebrew
$ brew install journey2md

Usage

Getting ready to use

The first thing you will need to do is create a full ZIP export of your Journey data, once you've done that unzip the export file into a directory, so that all the JSON data and photo attachments are individually available.

Assumptions for the "Vault"

As mentioned earlier, this tool assumes that you're going to be making an Obsidian Vault with the resulting Markdown. With this in mind the tool makes the following assumptions:

  • You wish to have a YYYY/MM/DD folder hierarchy for the entries.
  • You prefer to have all attachments held in a attachments folder below the location of the entry the attachments are for.

These are my preferences, if yours differ it should be simple enough to modify the code to taste (or, if what you prefer seems like it could be a reasonable configuration option, create an issue in the repo and tell me all about it).

Create the target "Vault"

Create a directory where the "Vault" will be created. Note that journey2md creates all directories and files within this directory.

Perform the conversion

With all the above done and in mind, run the tool like this:

journey2md journey-data markdown-vault

where journey-data is the path to the directory that holds all of the extracted Journey files, and where markdown-vault is the directory you created that will be the Vault.

Getting help

If you need help please feel free to raise an issue.

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

journey2md-1.0.0.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

journey2md-1.0.0-py3-none-any.whl (29.9 kB view details)

Uploaded Python 3

File details

Details for the file journey2md-1.0.0.tar.gz.

File metadata

  • Download URL: journey2md-1.0.0.tar.gz
  • Upload date:
  • Size: 30.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for journey2md-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4f3f82bbbb705d69677dc10efc1e2274188eda1d5ccd1addb14859cbd7819824
MD5 44edf96b12f271bfd93a77c8a31271c1
BLAKE2b-256 141764e784ee4e8d88c4951bdd61904cf37296214d4f7fb4d0ec410ab0922a35

See more details on using hashes here.

File details

Details for the file journey2md-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: journey2md-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 29.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for journey2md-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5793cb18d97b657978915be9216a5e9d15df3b48d1df60d20e9da59cd9e20724
MD5 872e6501b48fd0ccd184334b172bb8c2
BLAKE2b-256 4eefd1e33c31a96dd1203903fb97daf1b98d832cb18e6304d8ee55e886cdae7d

See more details on using hashes here.

Supported by

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