optify 0.20.4

Simplifies getting the right configuration options for a process using pre-loaded configurations from files (JSON, YAML, etc.) to manage options for experiments or flights. This library is mainly made to support building implementations for other languages such as Node.js, Python, and Ruby. It is not meant to be consumed directly yet.
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
49
50
51
52
53

# Optify in Rust

[![Crates.io](https://img.shields.io/crates/v/optify)](https://crates.io/crates/optify)
[![docs.rs](https://img.shields.io/docsrs/optify)](https://docs.rs/optify)

The core implementation of Optify in Rust.
Simplifies getting the right configuration options for a process using pre-loaded configurations from files (JSON, YAML, etc.) to manage options for experiments or flights.

See [tests](../../tests/) for examples and tests for different implementations of this format for managing options.

See the root [README.md](../../README.md) for more information and examples.

⚠️ Development in progress ⚠️\
APIs are not final and may change, for example, names may change.
This is just meant to be minimal to get started and help build Python and Ruby libraries.

## How It Works

The [`config`][config] crate (library) is used to help combine configuration files.

Optionally, when working locally, there is support to watch for changes to the configuration files and folders using the [`notify-debouncer-full`][notify-debouncer-full] crate (library).

## Testing

Run:
```shell
cargo test
```

## Formatting
To automatically change code, run:
```shell
cargo fmt && cargo clippy --fix --allow-dirty --allow-staged
```

## Benchmarking
Run:
```shell
cargo build --release
cargo bench

# Open one of the reports
open target/criterion/*/report/index.html 
```

## Publishing
```shell
cargo login
cargo publish
```

[config]: https://crates.io/crates/config
[notify-debouncer-full]: https://crates.io/crates/notify-debouncer-full