minknow-api-rust
| Crates.io | minknow-api-rust |
| lib.rs | minknow-api-rust |
| version | 0.3.0 |
| source | src |
| created_at | 2022-11-28 22:45:23.840844 |
| updated_at | 2023-05-26 15:51:42.300209 |
| description | Protobuf and gRPC specifications for the MinKNOW API with a Rust implementation |
| homepage | |
| repository | https://github.com/dayzerodx/minknow_api_rust |
| max_upload_size | |
| id | 724815 |
| size | 427,430 |
Cabell Maddux (cmaddux)
documentation
README
MinKNOW API Rust Client
This is currently an early implementation and should not be used in production settings. This is NOT an official ONT project.
A rust implementation of the minknow_api client for interacting with MinKNOW. More information on MinKNOW and minknow_api client, see the minknow_api python client repository.
Note that this library attempts to match the interfaces of the minknow_api python client, however, in some cases, additional interfaces have been added to simplify client usage.
Contributing
Prequisites:
- Rust
- Cargo
- MinKNOW >=22.10.7 installed and running locally
End to end tests associated with the minknow-api-rust client currently interact directly with a running minknow instance to create simulated devices. The following setup must be performed prior to running tests:
- Create a developer API token by opening the MinKNOW desktop application and navigating to 'Host Settings' -> 'API Access Tokens'.
- An environment variable must reference this token, run
export MINKNOW_API_TEST_TOKEN={created_token} - An environment variable must reference the self-signed certificate provided with the MinKNOW installation (for example, on MacOS run
export MINKNOW_TRUSTED_CA="/Applications/MinKNOW.app/Contents/Resources/conf/rpc-certs/ca.crt")
Once above prerequisites tests can be run with cargo test --tests.