misskey-rs icon indicating copy to clipboard operation
misskey-rs copied to clipboard

:v: Client library for Misskey :smiling_face_with_three_hearts:

misskey-rs

crates.io docs.rs CI

misskey-rs is an asynchronous Misskey client library for Rust.

use misskey::prelude::*;
use misskey::HttpClient;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
  let client = HttpClient::builder("https://your.instance.example/api/")
      .token("API_TOKEN")
      .build()?;

  client.create_note("Hello, Misskey").await?;

  Ok(())
}

Take a look at the example directory for more examples.

Usage

Add the following to your Cargo.toml:

[dependencies]
misskey = { version = "0.3.0-rc.1", features = ["12-75-0"] }

To run the example above, you will need to add the following dependencies:

tokio = { version = "1.0", features = ["full"] }
anyhow = "1.0"

See the API documentation for further details.

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