twitter-archive 0.0.3

A CLI tool to download media from bookmarked tweets.

Twitter-Archive

A CLI Python application to download all media (and hopefully more) from bookmarked tweets (for now). Eventually I hope to make this a general archive utility for Twitter, allowing users to download/archive all kinds of tweets.

Originally, before the V2 Twitter API, this app used Selenium to try and scrape the contents of the a users bookmarks page. Now, since the release of the V2 API, the application has been rewritten. This new version is much faster and more robust.

---

Installation and Setup

Installation

Twitter-Archive can be installed with pip

```sh
$ pip install twitter-archive
```

Alternatively, you can clone this repository and install from the repository instead of from PyPi.

```sh
$ git clone https://github.com/jarulsamy/Twitter-Archive
$ cd Twitter-Archive
$ pip install .
```

To properly authenticate with the Twitter API, you will have to create a developer application. This will provide you with a client ID and client secret.

TODO: Document how to create Twitter Developer App.

Usage

You can invoke the app with:

```sh
$ twitter-archive
```

By default, the app will print a URL to prompt the user to authorize the application with Twitters official APIs. Once you navigate to that link and login with Twitter, the app will fetch a manifest of all the bookmarked tweets and begin saving any photos/videos to disk.

You can view the built-in CLI help menu for more info:

$ twitter-archive --help
Twitter Archival Tool

A CLI tool to archive tweets.

Usage:
    twitter-archive [options]

Options:
    -s, --skip                  Use the existing metadata file if possible.
    -o, --media-output=FILE     Path to output media    [default: ./media]
    -m, --metadata-output=FILE  Path to output metadata [default: ./bookmarks.json]
    --headless                  Don't use interactive authentication

    -h --help                   Show this help
    -v --version                Show version

Acknowledgements

The Twitter developer team did an excellent job on the new APIs. The new APIs are substantially more intuitive and allow us to interact with many more features of Twitter. While it did take two years, the openness, transparency, and attention to feedback is much appreciated!

The relevant forumn post is available here.