Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kulapard/dayone-to-obsidian
Day One to Obsidian Converter
https://github.com/kulapard/dayone-to-obsidian
converter dayone json obsidian python
Last synced: 3 months ago
JSON representation
Day One to Obsidian Converter
- Host: GitHub
- URL: https://github.com/kulapard/dayone-to-obsidian
- Owner: kulapard
- License: mit
- Created: 2023-12-05T17:06:29.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-30T16:33:07.000Z (3 months ago)
- Last Synced: 2024-10-01T14:48:01.682Z (3 months ago)
- Topics: converter, dayone, json, obsidian, python
- Language: Python
- Homepage:
- Size: 127 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Day One to Obsidian Converter
[](https://github.com/kulapard/dayone-to-obsidian/actions/workflows/ci.yml)
[](https://codecov.io/github/kulapard/dayone-to-obsidian)
[](https://pypi.org/project/dayone-to-obsidian)
---
Convert your [Day One](https://dayoneapp.com/) journal entries into Markdown files
compatible with [Obsidian](https://obsidian.md).
## Features
- **Complete Data Migration**: Transfers all text, images, and metadata (including creation dates) from Day One entries.
- **Markdown Formatting**: Converts Day One entries into Markdown format, making them compatible with Obsidian and other
Markdown editors.
- **Tag Support**: Migrates all tags from Day One, allowing for easy categorization and search within Obsidian.
- **Image Embedding**: Automatically transfers and embeds any images from Day One entries into the Markdown files.
## Prerequisites
Before using `dayone-to-obsidian`, ensure you have the following:
- Python 3.10 or higher installed on your machine.
- Your Day One journal exported in JSON format.
- Obsidian installed if you wish to immediately start using your migrated files in Obsidian.
## Installation
```bash
pip install dayone-to-obsidian
```
## Usage
Follow these steps for conversion:
1. **Prepare Your Day One Export**:
Export your Day One journal entries to a JSON file or directory containing multiple JSON files following the
[manual](https://dayoneapp.com/guides/tips-and-tutorials/exporting-entries).
2. **Run the Conversion**:
Open a terminal or command prompt and execute the
CLI with the appropriate options.
The command structure is as follows:
```bash
dayone-to-obsidian run --json /path/to/your/dayone_export.json --target /path/to/target_directory [--force] [--tag-prefix=prefix] [--tag=tag1] [--tag=tag2]
```
- `--json`: Path to your Day One export JSON file or directory.
If not specified, it defaults to the current directory.
- `--target`: Path to the directory where converted Markdown files will be saved.
By default, a new folder is created in the current directory.
- `--force`: Force the overwriting of existing journal folder.
- `--tag-prefix`: Prefix for tags, allowing customization of how tags are formatted in the converted files.
- `--tag`: Additional tag(s) to add to all entries. This option can be repeated to include multiple tags.
- `--help`: Display the help message.
Example command:
```bash
dayone-to-obsidian run --json ./DayOneExport/Journal.json --target ./ObsidianNotes --tag-prefix=DayOne/ --tag=Imported --tag=Journal
```
This command specifies a Day One JSON export file, sets the target directory for the converted Markdown files, adds a
prefix to all tags, and includes additional tags for each entry.
3. **Import to Obsidian**:
Once the conversion process is complete, manually move the generated Markdown files to your Obsidian vault directory.
## Support
If you encounter any issues or have suggestions for improvements, please open an issue in this GitHub repository.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.