https://github.com/davep/bird2glass

A tool for converting my pre-Musk Twitter archive into an Obsidian Vault
https://github.com/davep/bird2glass

converter exporter markdown obsidian obsidian-md python python3 twitter

Last synced: 4 days ago
JSON representation

A tool for converting my pre-Musk Twitter archive into an Obsidian Vault

• Host: GitHub
• URL: https://github.com/davep/bird2glass
• Owner: davep
• License: gpl-3.0
• Created: 2024-11-02T10:04:17.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-11T14:42:42.000Z (14 days ago)
• Last Synced: 2024-12-11T15:43:48.901Z (14 days ago)
• Topics: converter, exporter, markdown, obsidian, obsidian-md, python, python3, twitter
• Language: Python
• Homepage: https://pypi.org/project/bird2glass/
• Size: 432 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bird2glass

## Introduction

This is a simple command line tool that can be used to turn a Twitter

archive into an Obsidian Vault.

> [!NOTE]

> This code was written while working with a Twitter archive created in

> 2022, in the days before Twitter had the new owner. I've since stopped

> using Twitter and have no idea if the form of the archive is the same.

![Graph view of my Tweets](https://raw.githubusercontent.com/davep/bird2glass/refs/heads/main/imgs/bird2glass.png)

## Installing

### pipx

The package can be installed using [`pipx`](https://pypa.github.io/pipx/):

```sh

$ pipx install bird2glass

```

### Homebrew

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

```sh

$ brew tap davep/homebrew

$ brew install bird2glass

```

## Usage

### Prepare for the conversion

1. Extract your Twitter archive into a directory.

2. Create a directory that will become the vault.

### Do the conversion

```sh

bird2glass tweets-file obsidian-vault

```

where `tweets-file` is the file that contains all of your tweets (this

should be `tweets.js` within the extracted directory) and `obsidian-vault`

is the directory you created that will be the Obsidian Vault.

## Notes and assumptions

This tool was built in part as an experiment in what can be done with

Obsidian, in part for fun, and fully for my own needs. As such there might

be assumptions and design decisions in here that won't match what you need.

Updates to make the code more general are welcome; likewise hacking it to

make it work "just so" for you is encouraged.

Some things to note:

- Everything relating to hashtags is left to Obsidian's understanding of

  hashtags. I don't know if Twitter and Obsidian's "specification" for a

  hashtag are the same, but I'm working on the assumption they are.

- Every single tweet is turned into its own Markdown file. If you tweeted a

  lot, expect a *lot* of files to be created.

- Back in the day, before you could attach media to tweets, I used TwitPic a

  lot. This tool attempts to detect TwitPic images and tries to embed them

  using an `iframe`.

- Where attached media is available and easy to work out, it is stored in

  the vault as an attachment.

- Currently actual proper videos aren't stored in the archive from Twitter

  and so aren't easy to grab and handle; this means some video media will be

  missing. I hope to work on this some more in the future (I seldom attached

  videos so it's not a huge issue for me).

- This only pulls in Tweets, not DMs, Periscopes, Circles, Moments, etc. I

  might expand it in the future.

## Getting help

If you need help please feel free to [raise an

issue](https://github.com/davep/bird2glass/issues).

[//]: # (README.md ends here)