Git Product home page Git Product logo

crunchyroll-rs's Introduction

crunchyroll-rs

A Rust library for the undocumented Crunchyroll api.

crates.io Docs CI License Discord

We are in no way affiliated with, maintained, authorized, sponsored, or officially associated with Crunchyroll LLC or any of its subsidiaries or affiliates. The official Crunchyroll website can be found at https://crunchyroll.com/.

Documentation

The documentation is available at docs.rs.

Example

You need this crate and tokio as dependency in your Cargo.toml in order to start working:

[dependencies]
crunchyroll-rs = "0.8"
tokio = { version = "1", features = ["full"] }

The following code prints the data of the episode behind the given url:

use crunchyroll_rs::{Crunchyroll, MediaCollection};
use crunchyroll_rs::parse::UrlType;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Log in to Crunchyroll with your email and password.
    // Support for username login was dropped by Crunchyroll on December 6th, 2023
    let crunchyroll = Crunchyroll::builder()
        .login_with_credentials("<email>", "<password>")
        .await?;

    let url = crunchyroll_rs::parse_url("https://www.crunchyroll.com/watch/GRDQPM1ZY/alone-and-lonesome").expect("url is not valid");
    if let UrlType::EpisodeOrMovie(media_id) = url {
        if let MediaCollection::Episode(episode) = crunchyroll.media_collection_from_id(media_id).await? {
            println!(
                "Url is episode {} ({}) of {} season {}",
                episode.episode_number,
                episode.title,
                episode.series_title,
                episode.season_number
            )
        }
    } else {
        panic!("Url is not a episode")
    }

    Ok(())
}

More examples can be found in the examples/ directory.

Api Coverage

Crunchyroll regularly updates their api but does not provide any documentation for it. Because we do not monitor the api constantly, so we cannot immediately say when a new endpoint is added or something has changed on already existing and implemented endpoints (which is semi-covered by the __test-strict feature, at least). If you find an endpoint which is not implemented or has changes feel free to open a new issue and tell us, or fork the library and implement it yourself.

Cloudflare

Crunchyroll uses the cloudflare bot protection to detect if requests are made by a human. Obviously this crate makes automated requests and thus, Cloudflare sometimes blocks requests. The crate catches these errors with the error::CrunchyrollError::Block enum field. The block occurs depending on different factors like your location. If such a block occurs you can try to create a custom reqwest::Client which has the needed configuration to bypass this check, like other user agents or tls backends (note that reqwest currently only supports native-tls besides rustls as tls backend, which is confirmed to work with openssl on Linux only, on Windows the blocks are even more aggressive). The configurations may vary on the factors addressed so there is no 100% right way to do it.

License

This project is licensed under either of the following licenses, at your option:

crunchyroll-rs's People

Contributors

bytedream avatar dependabot[bot] avatar malaow3 avatar adracea avatar nightquest avatar ichbinleoon avatar redbaty avatar frooastside avatar derro8 avatar

Watchers

 avatar

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.