atspi 0.0.1

Bindings to the Assistive Technology Service Provider Interface over dbus
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# AT-SPI for Rust

[![crates.io badge](http://meritbadge.herokuapp.com/atspi)](https://crates.io/crates/atspi)
[![docs.rs badge](https//docs.rs/atspi/badge.svg)](https://docs.rs/atspi)

Higher level, asynchronous Rust bindings to [AT-SPI2](https://www.freedesktop.org/wiki/Accessibility/AT-SPI2/), using
[zbus][https://crates.io/crates/zbus].

Part of the [Odilia screen reader project](https://odilia.app).

## Design

These bindings are currently general purpose, and can be used in any project. While we intend to try keeping it that
way, the design of this crate will likely be affected by the design of Odilia, particularly by it's addon API, which
requires that addons from different languages be able to access objects from this crate.

This crate makes use of the [zbus crate](https://crates.io/crates/zbus) for [dbus
communication](https://www.freedesktop.org/wiki/Software/dbus/). We use the asynchronous zbus API, so to use atspi, you
will need to run an async executer like [tokio](https://crates.io/crates/tokio) or
[async-std](https://crates.io/crates/async-std). The async-io` and `tokio` features are exposed and will be passed
through to zbus.

## Usage

Add this to `Cargo.toml`:

```toml
[dependencies]
atspi = "0.0.1"
```

## Contributing

We love people who add functionality, find bugs, or improve code quality!
You can clone the respository and make modifications just by `git clone`-ing the repository like so:

```bash
$ git clone https://github.com/odilia-app/odilia
$ cd odilia/atspi
$ cargo build
```

At this time, you need to download our entire `odilia` respository to make modifications to the `atspi` crate.
This will be changed in the future.

## License

All our code is licensed under the [GPL v3](https://www.gnu.org/licenses/gpl-3.0.html).