https://github.com/aneoconsulting/armonik.api

Defines and provides prebuilt gRPC API to interact with ArmoniK
https://github.com/aneoconsulting/armonik.api

api armonik grpc

Last synced: 14 days ago
JSON representation

Defines and provides prebuilt gRPC API to interact with ArmoniK

• Host: GitHub
• URL: https://github.com/aneoconsulting/armonik.api
• Owner: aneoconsulting
• License: apache-2.0
• Created: 2022-01-12T21:14:36.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-01-02T16:43:22.000Z (15 days ago)
• Last Synced: 2025-01-02T17:42:20.836Z (15 days ago)
• Topics: api, armonik, grpc
• Language: Rust
• Homepage: https://aneoconsulting.github.io/ArmoniK.Api/
• Size: 5.12 MB
• Stars: 10
• Watchers: 6
• Forks: 11
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ArmoniK.Api

| Javascript |   C#   | Python |

| :--------: | :----: | :----: |

| [![NPM version](https://img.shields.io/npm/v/@aneoconsultingfr/armonik.api.angular?color=fe5001&label=Angular)](https://www.npmjs.com/package/@aneoconsultingfr/armonik.api.angular) | [![Nuget version](https://img.shields.io/nuget/v/ArmoniK.Api.Client?color=fe5001&label=Client)](https://www.nuget.org/packages/ArmoniK.Api.Client) | [![PyPI version](https://img.shields.io/pypi/v/armonik?color=fe5001&label=armonik)](https://pypi.org/project/armonik/) |

[![NPM version](https://img.shields.io/npm/v/@aneoconsultingfr/armonik.api?color=fe5001&label=Web)](https://www.npmjs.com/package/@aneoconsultingfr/armonik.api) | [![Nuget version](https://img.shields.io/nuget/v/ArmoniK.Api.Common?color=fe5001&label=Common)](https://www.nuget.org/packages/ArmoniK.Api.Common) | |

|  | [![Nuget version](https://img.shields.io/nuget/v/ArmoniK.Api.Common.Channel?color=fe5001&label=Common.Channel)](https://www.nuget.org/packages/ArmoniK.Api.Common.Channel) |  |

|  | [![Nuget version](https://img.shields.io/nuget/v/ArmoniK.Api.Core?color=fe5001&label=Core)](https://www.nuget.org/packages/ArmoniK.Api.Core) |  |

| | [![Nuget version](https://img.shields.io/nuget/v/ArmoniK.Api.Worker?color=fe5001&label=Worker)](https://www.nuget.org/packages/ArmoniK.Api.Worker) | |

This project is part of the [ArmoniK](https://github.com/aneoconsulting/ArmoniK) project.

In particular it is a constituent of its [Core](https://github.com/aneoconsulting/ArmoniK.Core)

component which, among its main functionalities, implements several gRPC services aiming to

provide a user with a robust task scheduler for a high throughput computing application.

The .proto files in the directory [./Protos/V1](https://github.com/aneoconsulting/ArmoniK.Api/tree/main/Protos/V1)

provide the core data model and functionalities for ArmoniK and are used to generate the different SDKs.

## Documentation

[See this link](https://aneoconsulting.github.io/ArmoniK.Api/api/index.html) to explore documentation.

Documentation for `.proto` files is generated with the plugin [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) during the build process in the CI/CD pipeline.

Documentation for `.csproj` files is generated with [DocFX](https://dotnet.github.io/docfx/) during the build process in the CI/CD pipeline.

## Contributing

Contributions are always welcome!

See [CONTRIBUTING.md](https://github.com/aneoconsulting/ArmoniK.Api/blob/main/CONTRIBUTING.md) for ways to get started.

### Improve Protocol Documentation

Please refer to [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc) to make sure to adhere to

the format the plugin expects to correctly generate documentation. You can find examples at the end section of [protoc-gen-doc](https://github.com/pseudomuto/protoc-gen-doc#output-example).