Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iddm/toornament-rs

A rust library for toornament.com service
https://github.com/iddm/toornament-rs

api rust toornament tournament

Last synced: 23 days ago
JSON representation

A rust library for toornament.com service

Awesome Lists containing this project

README

        

# toornament-rs
[![CI](https://github.com/iddm/toornament-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/iddm/toornament-rs/actions/workflows/ci.yml)
[![Crates](https://img.shields.io/crates/v/toornament.svg)](https://crates.io/crates/toornament)
[![Docs](https://docs.rs/toornament/badge.svg)](https://docs.rs/toornament)
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)

http://toornament.com api bindings.

## Status
Updating to the API version 2 is in progress.

## How to use
There is a [book](https://iddm.github.io/toornament-rs) and the
[documentation](https://docs.rs/toornament) which may help you using this library.

## Implementation
- Immutable interface, no need to synchronize, thread-safe.
- No unsafe blocks.
- No unwraps (except the tests).
- `reqwest` crate is used for performing requests.

## Usage
Start by creating `Toornament` instance and perform needed operations after.

```rust,no_run
extern crate toornament;
use toornament::*;

fn main() {
let t = Toornament::with_application("API_TOKEN", "CLIENT_ID", "CLIENT_SECRET")
.unwrap();
assert!(t.disciplines(None).is_ok());
}
```

More examples are in the [`examples/` subdirectory](./examples/).

## License
This project is [licensed under the MIT license](https://github.com/iddm/toornament-rs/blob/master/LICENSE).