43 releases

new 0.2.13 Feb 21, 2024
0.2.11 Aug 22, 2023
0.2.10 Mar 7, 2023
0.2.8 Sep 27, 2022
0.1.5 Mar 26, 2019

#2 in #talk

Download history 179/week @ 2023-11-05 96/week @ 2023-11-12 105/week @ 2023-11-19 242/week @ 2023-11-26 117/week @ 2023-12-03 138/week @ 2023-12-10 104/week @ 2023-12-17 151/week @ 2023-12-24 156/week @ 2023-12-31 167/week @ 2024-01-07 163/week @ 2024-01-14 262/week @ 2024-01-21 210/week @ 2024-01-28 88/week @ 2024-02-04 295/week @ 2024-02-11 1093/week @ 2024-02-18

1,702 downloads per month
Used in 5 crates (3 directly)

MIT/Apache

125KB
2.5K SLoC

Build Status crates.io docs.rs

A MediaWiki client library in Rust

Examples

Get all categories of "Albert Einstein" on English Wikipedia

let api = mediawiki::api_sync::ApiSync::new("https://en.wikipedia.org/w/api.php").unwrap();

// Query parameters
let params = api.params_into(&[
    ("action", "query"),
    ("prop", "categories"),
    ("titles", "Albert Einstein"),
    ("cllimit", "500"),
]);

// Run query; this will automatically continue if more results are available, and merge all results into one
let res = api.get_query_api_json_all(&params).unwrap();

// Parse result
let categories: Vec<&str> = res["query"]["pages"]
    .as_object()
    .unwrap()
    .iter()
    .flat_map(|(_page_id, page)| {
        page["categories"]
            .as_array()
            .unwrap()
            .iter()
            .map(|c| c["title"].as_str().unwrap())
    })
    .collect();

dbg!(&categories);

Edit the Wikidata Sandbox Item (as a bot)

let mut api = mediawiki::api::Api::new("https://www.wikidata.org/w/api.php").unwrap();
api.login("MY BOT USER NAME", "MY BOT PASSWORD").unwrap();

let token = api.get_edit_token().unwrap();

let params = api.params_into(&[
    ("action", "wbeditentity"),
    ("id", "Q4115189"),
    ("data", r#"{"claims":[{"mainsnak":{"snaktype":"value","property":"P1810","datavalue":{"value":"ExampleString","type":"string"}},"type":"statement","rank":"normal"}]}"#),
    ("token", &token),
]);

let res = api.post_query_api_json(&params).unwrap();
dbg!(res);

Edit via OAuth

let json = json!({"g_consumer_key":"YOUR_CONSUMER_KEY","g_token_key":"YOUR_TOKEN_KEY"});
let oauth = mediawiki::api::OAuthParams::new_from_json(&json);
let mut api = mediawiki::api::Api::new("https://www.wikidata.org/w/api.php").unwrap();
api.set_oauth(Some(oauth));

Query Wikidata using SPARQL

let api = mediawiki::api::Api::new("https://www.wikidata.org/w/api.php").unwrap(); // Will determine the SPARQL API URL via site info data
let res = api.sparql_query ( "SELECT ?q ?qLabel ?fellow_id { ?q wdt:P31 wd:Q5 ; wdt:P6594 ?fellow_id . SERVICE wikibase:label { bd:serviceParam wikibase:language '[AUTO_LANGUAGE],en'. } }" ).unwrap() ;
println!("{}", ::serde_json::to_string_pretty(&res).unwrap());

License

Licensed under either of

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 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~8–22MB
~335K SLoC