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
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/DDfolder hierarchy for the entries. - You prefer to have all attachments held in a
attachmentsfolder 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.
Metadata
Release files for journey2md 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| journey2md-1.0.0.tar.gz | 30.6 kB | Without provenance | Details for journey2md-1.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| journey2md-1.0.0-py3-none-any.whl | Python 3 | none | any | Details for journey2md-1.0.0-py3-none-any.whl |
Total release size: 60.5 kB
Release files / journey2md-1.0.0.tar.gz
| Download URL | journey2md-1.0.0.tar.gz |
|---|---|
| Size | 30.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4f3f82bbbb705d69677dc10efc1e2274188eda1d5ccd1addb14859cbd7819824
|
|
BLAKE2b-256 checksum How to use checksums |
141764e784ee4e8d88c4951bdd61904cf37296214d4f7fb4d0ec410ab0922a35
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.4
|
Release files / journey2md-1.0.0-py3-none-any.whl
| Download URL | journey2md-1.0.0-py3-none-any.whl |
|---|---|
| Size | 29.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5793cb18d97b657978915be9216a5e9d15df3b48d1df60d20e9da59cd9e20724
|
|
BLAKE2b-256 checksum How to use checksums |
4eefd1e33c31a96dd1203903fb97daf1b98d832cb18e6304d8ee55e886cdae7d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.12.4
|
Security for journey2md 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.