Skip to main content

An advanced tool for backing up Tumblr blogs.

Project description

tumblr-backup

Discord

tumblr-backup is a Python tool that backs up your Tumblr blog locally as HTML files, preserving all your posts, images, and media. It creates a beautiful, browsable archive of your blog that you can view offline.

This is a fork of bbolli's tumblr-utils, with added Python 3 compatibility, bug fixes, support for dashboard-only blogs, and many other enhancements.

Quick Start

Step 1: Install Python (if you don't have it)

Windows and macOS: Download and install Python from python.org. During installation on Windows, check the box that says "Add Python to PATH" — this is important!

Linux: Python is usually already installed. You can check by opening a terminal and typing python3 --version.

Step 2: Install tumblr-backup

Open a terminal. Then run the install command for your system:

Windows or macOS (if you installed Python from python.org)
pip install tumblr-backup

Tip: If pip isn't recognized, try python -m pip install tumblr-backup instead.

Linux or Homebrew

On Linux (and macOS with Homebrew Python), the recommended way to install command-line tools is pipx, which manages them in isolated environments:

Ubuntu/Debian:

sudo apt install pipx
pipx install tumblr-backup

Fedora:

sudo dnf install pipx
pipx install tumblr-backup

macOS (Homebrew):

brew install pipx
pipx install tumblr-backup

Other distros / alternative method: If your package manager doesn't have pipx, you can use uv, a fast Python tool installer:

curl -LsSf https://astral.sh/uv/install.sh | sh
uv tool install tumblr-backup

Step 3: Get a Tumblr API key

  1. Go to https://www.tumblr.com/oauth/apps (log in if needed)
  2. Click Register application
  3. Fill in any values for the required fields (the specific values don't matter)
  4. Copy the OAuth Consumer Key shown on the next page

Step 4: Save your API key

tumblr-backup --set-api-key YOUR_API_KEY

Replace YOUR_API_KEY with the key you copied.

Step 5: Back up a blog

tumblr-backup blog-name

For example, to back up staff.tumblr.com:

tumblr-backup staff

This will create a staff/ directory in your current folder containing an index.html file you can open in your browser to view the backup, along with monthly archive pages, individual post pages, and all images and media.

Updating an existing backup

To add only new posts to an existing backup:

tumblr-backup -i blog-name

Optional extras

tumblr-backup has optional features you can enable by installing extras. Add them in square brackets after the package name:

pip install "tumblr-backup[video]"

(On Linux/Homebrew, replace pip install with pipx install or uv tool install as above.)

Extra What it does
video Save video files (uses yt-dlp)
exif Add post tags to image EXIF metadata
jq Filter posts with custom rules
dash Back up dashboard-only blogs
all All of the above

Documentation

Support & Community

If you get stuck, have questions, or want to request features, join the Discord:

Join the Discord server →

Third-party Components

This project redistributes npf2html (MIT) from https://github.com/nex3/npf2html at commit 05d602a.

  • Upstream license: see 3rdparty/npf2html/LICENSE.
  • Source used to produce the bundled JS: 3rdparty/npf2html/ with build steps in 3rdparty/README.md.

Acknowledgments

  • bdoms for the initial implementation
  • WyohKnott for numerous bug reports and patches
  • Tumblr for their discontinued backup tool whose output was the inspiration for the styling applied in tumblr_backup.
  • Beat Bolli

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

tumblr_backup-1.6.4.tar.gz (99.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tumblr_backup-1.6.4-py3-none-any.whl (98.8 kB view details)

Uploaded Python 3

File details

Details for the file tumblr_backup-1.6.4.tar.gz.

File metadata

  • Download URL: tumblr_backup-1.6.4.tar.gz
  • Upload date:
  • Size: 99.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for tumblr_backup-1.6.4.tar.gz
Algorithm Hash digest
SHA256 9ef585446c33723c0f2b59cf73fbf08df2d01b5a45a7234d3b7b8c7d13857054
MD5 9520a2f8494caf572b877646c6623efc
BLAKE2b-256 86f80709046a9bb86585a39dc4efa0ce5f83faab6f8a453ed0246e1b67dd8b54

See more details on using hashes here.

File details

Details for the file tumblr_backup-1.6.4-py3-none-any.whl.

File metadata

  • Download URL: tumblr_backup-1.6.4-py3-none-any.whl
  • Upload date:
  • Size: 98.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for tumblr_backup-1.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4e580ce0c6b33b0ea73f476cd033ff80f750d3802f033899f4005d8295a0b8ea
MD5 18eba2d4701b55fd3329290a37ba3243
BLAKE2b-256 b8436b2cc1be02ace652b8f776785e62180873ace44076d9ec116de79fbb7d9b

See more details on using hashes here.

Supported by

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