https://github.com/charleprr/redditube

A video generator from Reddit posts and comments
https://github.com/charleprr/redditube

canvas ffmpeg generator reddit reddit-submissions tts video video-generator youtube

Last synced: 3 months ago
JSON representation

A video generator from Reddit posts and comments

• Host: GitHub
• URL: https://github.com/charleprr/redditube
• Owner: charleprr
• License: mit
• Created: 2020-05-13T21:55:48.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-11T18:52:07.000Z (10 months ago)
• Last Synced: 2024-10-22T21:45:37.210Z (3 months ago)
• Topics: canvas, ffmpeg, generator, reddit, reddit-submissions, tts, video, video-generator, youtube
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/redditube
• Size: 312 MB
• Stars: 57
• Watchers: 4
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Redditube

[![NPM Version](http://img.shields.io/npm/v/redditube.svg?style=flat)](https://www.npmjs.org/package/redditube)

[![NPM Downloads](https://img.shields.io/npm/dm/redditube.svg?style=flat)](https://npmcharts.com/compare/redditube?minimal=true)

[![LICENSE](https://img.shields.io/badge/license-MIT-de4328.svg)](https://github.com/charlypoirier/redditube/blob/master/LICENSE)

A video generator from Reddit posts and comments.


Watch [this video](https://streamable.com/7jqjup) made with Redditube.

## Installation

`npm install redditube`

Got installation errors? Install the following packages and try again.


`sudo apt install build-essential libpixman-1-dev libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev`

You will need to have [FFmpeg](https://ffmpeg.org/download.html) installed on your machine.


You will also need Reddit credentials.

- Create a [Reddit account](https://www.reddit.com/register/), if you don't already have one

- Create a [Reddit app](https://ssl.reddit.com/prefs/apps/)

    - Give it a name

    - Set the redirect URI to "http://127.0.0.1/"

We will need the Client ID (random string under the app name) and Client secret later.

## Usage

```js

const Redditube = require("redditube");

// Configure access to Reddit

Redditube.config({

    "userAgent": "Redditube",

    "clientId": "",     // Your Client ID

    "clientSecret": "", // Your Client secret

    "username": "",     // Your Reddit username

    "password": ""      // Your Reddit password

});

// Log start, status, errors and end events (optional)

Redditube.on("start", () => console.log("Start event!"));

Redditube.on("status", status => console.log(status));

Redditube.on("error", error => console.error(error));

Redditube.on("end", () => console.log("End event!"));

// Option 1

// Use .then() and .catch()

Redditube.make("f9cufu", 3).then(videoPath => {

    console.log(videoPath);

}).catch(error => {

    console.log(error);

});

// Option 2

// Await a promise (inside an asynchronous function)

const videoPath = await Redditube.make("f9cufu", 3);

```

The above example makes a video from [this post](https://www.reddit.com/r/AskReddit/comments/f9cufu/what_are_some_ridiculous_history_facts/) (see **f9cufu** in the URL) and with **3** comments.

## Contributing

Feel free to star the repository, create issues and make pull requests on [GitHub](https://github.com/charlypoirier/redditube).

## License

Released under the [MIT](https://github.com/charlypoirier/redditube/blob/master/LICENSE) license.