Giter Site home page Giter Site logo

charlypoirier / redditube Goto Github PK

View Code? Open in Web Editor NEW
55.0 4.0 12.0 319.53 MB

A video generator from Reddit posts and comments

Home Page: https://www.npmjs.com/package/redditube

License: MIT License

JavaScript 100.00%
reddit youtube video generator reddit-submissions video-generator ffmpeg canvas tts

redditube's Introduction

Redditube

NPM Version NPM Downloads LICENSE

A video generator from Reddit posts and comments.
Watch this video 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 installed on your machine.
You will also need Reddit credentials.

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

Usage

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 (see f9cufu in the URL) and with 3 comments.

Contributing

Feel free to star the repository, create issues and make pull requests on GitHub.

License

Released under the MIT license.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.