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: 3 months ago
JSON representation

A rust library for toornament.com service

• Host: GitHub
• URL: https://github.com/iddm/toornament-rs
• Owner: iddm
• License: mit
• Created: 2017-06-01T14:12:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-20T22:44:18.000Z (8 months ago)
• Last Synced: 2024-07-22T20:33:42.726Z (4 months ago)
• Topics: api, rust, toornament, tournament
• Language: Rust
• Size: 663 KB
• Stars: 4
• Watchers: 1
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-rust - iddm/toornament-rs - Toornament.com API bindings. [](https://github.com/iddm/toornament-rs/actions/workflows/ci.yml) [](https://crates.io/crates/toornament) (Libraries / Game development)

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).