https://github.com/tatsh/patreon-archiver

Download Patreon content.
https://github.com/tatsh/patreon-archiver

api patreon

Last synced: 1 day ago
JSON representation

Download Patreon content.

• Host: GitHub
• URL: https://github.com/tatsh/patreon-archiver
• Owner: Tatsh
• License: mit
• Created: 2022-01-24T23:26:41.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2025-04-07T23:10:32.000Z (6 months ago)
• Last Synced: 2025-04-08T00:23:30.458Z (6 months ago)
• Topics: api, patreon
• Language: Python
• Homepage: https://patreon-archiver.rtfd.io/
• Size: 527 KB
• Stars: 17
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# patreon-archiver

[![Python versions](https://img.shields.io/pypi/pyversions/patreon-archiver.svg?color=blue&logo=python&logoColor=white)](https://www.python.org/)

[![PyPI - Version](https://img.shields.io/pypi/v/patreon-archiver)](https://pypi.org/project/patreon-archiver/)

[![GitHub tag (with filter)](https://img.shields.io/github/v/tag/Tatsh/patreon-archiver)](https://github.com/Tatsh/patreon-archiver/tags)

[![License](https://img.shields.io/github/license/Tatsh/patreon-archiver)](https://github.com/Tatsh/patreon-archiver/blob/master/LICENSE.txt)

[![GitHub commits since latest release (by SemVer including pre-releases)](https://img.shields.io/github/commits-since/Tatsh/patreon-archiver/v0.1.3/master)](https://github.com/Tatsh/patreon-archiver/compare/v0.1.3...master)

[![CodeQL](https://github.com/Tatsh/patreon-archiver/actions/workflows/codeql.yml/badge.svg)](https://github.com/Tatsh/patreon-archiver/actions/workflows/codeql.yml)

[![QA](https://github.com/Tatsh/patreon-archiver/actions/workflows/qa.yml/badge.svg)](https://github.com/Tatsh/patreon-archiver/actions/workflows/qa.yml)

[![Tests](https://github.com/Tatsh/patreon-archiver/actions/workflows/tests.yml/badge.svg)](https://github.com/Tatsh/patreon-archiver/actions/workflows/tests.yml)

[![Coverage Status](https://coveralls.io/repos/github/Tatsh/patreon-archiver/badge.svg?branch=master)](https://coveralls.io/github/Tatsh/patreon-archiver?branch=master)

[![Documentation Status](https://readthedocs.org/projects/patreon-archiver/badge/?version=latest)](https://patreon-archiver.readthedocs.org/?badge=latest)

[![mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)

[![pydocstyle](https://img.shields.io/badge/pydocstyle-enabled-AD4CD3)](http://www.pydocstyle.org/en/stable/)

[![pytest](https://img.shields.io/badge/pytest-zz?logo=Pytest&labelColor=black&color=black)](https://docs.pytest.org/en/stable/)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

[![Downloads](https://static.pepy.tech/badge/patreon-archiver/month)](https://pepy.tech/project/patreon-archiver)

[![Stargazers](https://img.shields.io/github/stars/Tatsh/patreon-archiver?logo=github&style=flat)](https://github.com/Tatsh/patreon-archiver/stargazers)

[![@Tatsh](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fpublic.api.bsky.app%2Fxrpc%2Fapp.bsky.actor.getProfile%2F%3Factor%3Ddid%3Aplc%3Auq42idtvuccnmtl57nsucz72%26query%3D%24.followersCount%26style%3Dsocial%26logo%3Dbluesky%26label%3DFollow%2520%40Tatsh&query=%24.followersCount&style=social&logo=bluesky&label=Follow%20%40Tatsh)](https://bsky.app/profile/Tatsh.bsky.social)

[![Mastodon Follow](https://img.shields.io/mastodon/follow/109370961877277568?domain=hostux.social&style=social)](https://hostux.social/@Tatsh)

Save Patreon content you have access to.

## Installation

### Poetry

```shell

poetry add patreon-archiver

```

### Pip

```shell

pip install patreon-archiver

```

## Configuration

Video content will be saved using yt-dlp. You should ensure that you are logged into Patreon in the

appropriate browser profile.

Recommendations in `~/.config/yt-dlp/config` or equivalent file:

```plain

--cookies-from-browser chrome:Default

--add-metadata

--all-subs

--convert-subs srt

--embed-chapters

--embed-metadata

--embed-subs

--embed-thumbnail

--geo-bypass

--merge-output-format mkv

--no-overwrites

--sub-langs all

--write-info-json

--write-subs

--download-archive ~/somewhere-safe

```

## Usage

Run `patreon-archiver`. At minimum, campaign ID of the Patreon content creator is required. See help

with `--help`.

```plain

Usage: patreon-archiver [OPTIONS] CAMPAIGN_ID

Options:

  -o, --output-dir TEXT           Output directory

  -b, --browser TEXT              Browser to read cookies from

  -p, --profile TEXT              Browser profile

  -x, --fail                      Do not continue processing after a failed

                                  yt-dlp command.

  -L, --yt-dlp-arg-limit INTEGER  Number of media URIs to pass to yt-dlp at a

                                  time.

  -S, --sleep-time INTEGER        Number of seconds to wait between requests

  -d, --debug                     Enable debug output

  --help                          Show this message and exit.

```

## How to get the campaign ID

1. Go to the content creator's main page.

2. View the source and search for `patreon-media/p/campaign/`.

3. After the `/` there should be a number, as in `patreon-media/p/campaign/12345678`. In that case

   the campaign ID is `12345678`.