pexels

Pexels Project

This project consists of two main components: pexels-api and pexels-cli. The pexels-api is a Rust library for interacting with the Pexels API, while the pexels-cli is a command-line interface for using the pexels-api.

Features

• pexels-api:
  • Search for photos and videos
  • Retrieve individual photos and videos by ID
  • Search for collections
  • Retrieve featured collections
  • Supports asynchronous operations
• pexels-cli:
  • Command-line interface for searching photos, videos, and collections
  • Retrieve individual media items by their ID

Installation

pexels-api

Add the following to your Cargo.toml:

[dependencies]
dotenvy = "0.15.7"
pexels-api = { version = "0.1.0" }
reqwest = { version = "0.12.11", features = ["json"] }
serde = { version = "1.0.217", features = ["derive"] }
serde_json = "1.0.135"
thiserror = "2.0.9 "
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
url = "2.5.4"

pexels-cli

1. Clone the repository:

    git clone https://github.com/houseme/pexels.git
   

2. Navigate to the project directory:

    cd pexels/pexels-cli
   

3. Build the project:

    cargo build
   

Usage

Before using the library or CLI, make sure to set your Pexels API key in a .env file:

PEXELS_API_KEY=your_api_key_here

Pexels-api Example

Here is a basic example of how to use the pexels-api library:

use dotenvy::dotenv;
use pexels_api::{
    CollectionMediaParams, MediaSort, MediaType, PaginationParams, PexelsClient,
    PopularVideoParams, SearchParams, VideoSearchParams,
};
use std::env;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    dotenv().ok();
    let api_key = env::var("PEXELS_API_KEY")?;
    let client = PexelsClient::new(api_key);

    // Search for photos
    let photos = client
        .search_photos("nature", &SearchParams::new().per_page(10).page(1))
        .await?;
    for photo in photos.photos {
        println!("{:?}", photo);
    }

    // Get a photo by ID
    let photo = client.get_photo(10967).await?;
    println!("{:?}", photo);

    // Search for videos
    let videos = client
        .search_videos("nature", &VideoSearchParams::new().per_page(10).page(1))
        .await?;
    for video in videos.videos {
        println!("{:?}", video);
    }

    // Fetch popular videos with documented filters
    let popular_videos = client
        .popular_videos_with_params(
            &PopularVideoParams::new().per_page(10).page(1).min_width(1280).min_duration(5),
        )
        .await?;
    println!("{:?}", popular_videos);

    // Get a video by ID
    let video = client.get_video(3401900).await?;
    println!("{:?}", video);

    // List featured collections
    let collections = client
        .get_featured_collections(&PaginationParams::new().per_page(10).page(1))
        .await?;
    for collection in collections.collections {
        println!("{:?}", collection);
    }

    // Fetch collection media with type and sort filters
    let media_response = client
        .get_collection_media_with_params(
            "tszhfva",
            &CollectionMediaParams::new()
                .per_page(10)
                .page(1)
                .media_type(MediaType::Photo)
                .sort(MediaSort::Desc),
        )
        .await?;
    for media in media_response.media {
        println!("{:?}", media);
    }

    Ok(())
}

Pexels-cli Commands

• Search Photos:

    cargo run -- search-photos --query "nature" --per-page 10 --page 1
  

• Search Videos:

    cargo run -- search-videos --query "nature" --per-page 10 --page 1
  

• Get Photo by ID:

    cargo run -- get-photo --id 10967
  

• Get Video by ID:

    cargo run -- get-video --id 3401900
  

• Search Collections:

    cargo run -- search-collections --per-page 10 --page 1
  

• Search Media:

    cargo run -- search-media --query "nature" --per-page 10 --page 1 --type "photo" --sort "latest"
  

Documentation

For detailed documentation, please refer to pexels-api Documentation and pexels-cli Documentation.

License

Licensed under either of

• Apache License, Version 2.0, LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0
• MIT license LICENSE-MIT or http://opensource.org/licenses/MIT

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 or MIT license, shall be dual licensed as above, without any additional terms or conditions.

This site is open source. Improve this page.