Crate hypothesis

A Rust API for Hypothesis

Description

A lightweight wrapper and CLI for the Hypothesis Web API v1.0.0. It includes all APIKey authorized endpoints related to

• annotations (create / update / delete / search / fetch / flag),
• groups (create / update / list / fetch / leave / members)
• profile (user information / groups)

Installation and Usage

Authorization

You’ll need a Hypothesis account, and a personal API token obtained as described here. Set the environment variables $HYPOTHESIS_NAME and $HYPOTHESIS_KEY to your username and the developer API key respectively.

As a command-line utility:

cargo install hypothesis

Run hypothesis --help to see subcommands and options. NOTE: the CLI doesn’t currently have all the capabilities of the Rust crate, specifically bulk actions and updating dates are not supported.

Generate shell completions:

hypothesis complete zsh > .oh-my-zsh/completions/_hypothesis
exec zsh

As a Rust crate

Add to your Cargo.toml:

[dependencies]
hypothesis = {version = "0.4.0", default-features = false}
# For a tokio runtime:
tokio = { version = "0.2", features = ["macros"] }

Examples

use hypothesis::Hypothesis;
use hypothesis::annotations::{InputAnnotation, Target, Selector};

#[tokio::main]
async fn main() -> Result<(), hypothesis::errors::HypothesisError> {
    let api = Hypothesis::from_env()?;
    let new_annotation = InputAnnotation::builder()
            .uri("https://www.example.com")
            .text("this is a comment")
            .target(Target::builder()
               .source("https://www.example.com")
               .selector(vec![Selector::new_quote("exact text in website to highlight",
                                                  "prefix of text",
                                                  "suffix of text")])
               .build()?)
           .tags(vec!["tag1".to_string(), "tag2".to_string()])
           .build()?;
    api.create_annotation(&new_annotation).await?;
    Ok(())
}

See the documentation of the API struct (Hypothesis) for a list of possible queries. Use bulk functions to perform multiple actions - e.g. api.fetch_annotations instead of a loop around api.fetch_annotation.

Check the documentation for more usage examples.

Changelog

See the CHANGELOG

Contributing

Make sure you have a .env file (added to .gitignore) in the repo root with HYPOTHESIS_NAME, HYPOTHESIS_KEY, and TEST_GROUP_ID

Caveats / Todo:

• Only supports APIKey authorization and hypothes.is authority (i.e. single users).
• Target.selector.RangeSelector doesn’t seem to follow W3C standards. It’s just a hashmap for now.
• Annotation hypermedia links are stored as a hashmap, b/c I don’t know all the possible values.
• Need to figure out how Document works to properly document it (hah).
• Can’t delete a group after making it, can leave it though (maybe it’s the same thing?)
• No idea what UserProfile.preferences and UserProfile.features mean.
• CLI just dumps output as JSON, this is fine right? Fancier CLIs can build on top of this (or use the crate directly)

Modules

annotations

Objects related to the “annotations” endpoint

cli

Objects related to the command-line tool

errors

API and CLI specific errors

groups

Objects related to the “groups” endpoint

profile

Objects related to the “profile” endpoint

Structs

Hypothesis

Hypothesis API client

UserAccountID

Stores user account ID in the form “acct:{username}@hypothes.is”

Constants

API_URL

Hypothesis API URL

Functions

serde_parse