consumet.rs
consumet.rs is a crates.io library which provides high-level APIs to get information about several entertainment mediums like books, movies, comics, anime, manga, etc.
/badge.svg?branch=auto&event=push)
Table of Contents
- [Quick Start](#quick-start)
- [Installation](#installation)
- [Usage](#usage)
- [Documentation](#documentation)
- [Ecosystem](#ecosystem)
- [Support](#support)
- [License](#license)
## Quick Start
### Installation
To use consumet.rs in your project, run:
```bash
cargo install consumet
```
### Usage
**Example** - searching for a movie using the flixhq provider.
```rs
use consumet::providers::movies;
#[tokio::main]
async fn main() -> anyhow::Result<()> {
// Create a new instance of the FlixHQ provider
let flixhq = movies::FlixHQ;
// Search for a movie. In this case, "Vincenzo"
let data = flixhq.search("Vincenzo", None).await?;
println!("{:#?}", data);
Ok(())
}
```
**Cargo.toml**
```toml
[package]
name = ""
version = "0.0.1"
edition = "2021"
[dependencies]
consumet = "0.0.11"
tokio = { version = "1.0", features = ["full"] }
anyhow = "1.0.79"
```
Do you want to know more? Head to the [`Getting Started`](https://github.com/carrotshniper21/consumet.rs/tree/master/docs/guides/getting-started.md).
## Documentation
- [`Getting Started`](https://github.com/carrotshniper21/consumet.rs/tree/master/docs/guides/getting-started.md)
- [`Guides`](https://github.com/carrotshniper21/consumet.rs/tree/master/docs)
- [`Movies`](https://github.com/carrotshniper21/consumet.rs/tree/master/docs/guides/movies.md)
## Ecosystem
- [Provider Status](https://github.com/consumet/providers-status/blob/main/README.md) - A list of providers and their status.
- [Discord Server](https://discord.gg/qTPfvMxzNH) - Join the official discord server and chat with the maintainers.
## Support
You can contact the maintainer of consumet.rs via [email](mailto:vipershniper07@gmail.com), or [join the official discord server](https://discord.gg/qTPfvMxzNH) (Recommended).
# Contributors
Checkout the original [`consumet.ts`](https://github.com/consumet/consumet.ts/)
Credits to the beautiful people who wrote the original consumet.ts:
[](https://github.com/consumet/consumet.ts/graphs/contributors)
## License
Licensed under [GPL-3.0](./LICENSE).