Skip to main content

GRPC python binding for the ArmoniK orchestrator API

Project description

ArmoniK.Api Python package

This folder contains the necessary scripts to generate the ArmoniK.Api Python package. Please note that while the package generation is platform dependent, the generated package should be compatible with Linux and Windows.

Install the Python Package from PyPI

At each release, we provide a prepackaged version of ArmoniK.Api available on PyPI here : https://pypi.org/project/armonik. To install the package to your current Python environment, you can use pip :

pip install armonik

Linux / WSL

How to generate

Requirements :

  • Python >= 3.7
  • Python3-venv
  • Pip3
  • Bash

If the python command doesn't link to python3 on your system, you may be able to install the package python-is-python3, which links python to python3.

To generate the package from sources, run the proto2python.sh script from its folder. You need to specify a directory where the virtual environment used for the build will be located. For example the following command will generate the packages and will create the build environment "pyvenv" in the current user's home directory:

./proto2python.sh ~/pyvenv

3 folders will be created :

  • generated : contains the source files used to create the package
  • build : contains the source files used to create the wheel package
  • pkg : contains the sdist and wheel packages

Instead of running the script you can install the armonik package in "editable" mode, allowing you to make changes to the source code, and the changes will be reflected immediately without reinstalling the package.

pip install -e ./packages/python

How to install the generated package

From this directory, use the following command:

pip install pkg/armonik*.whl

The generated package will be installed to your current python environment

Windows

Coming soon

Tests

Test Environment Setup

Before running tests, ensure the following setup steps are completed:

  1. Install Dependencies:
sudo apt install dotnet-sdk-6.0 jq
  1. Launch the Mock Server:

Verify that port 5000 is available (Armonik and the mock server communicate on the same port, uninstall armonik if necessary):

lsof -i :5000
  1. Launch the server from the project's root directory in a separate terminal:
cd packages/csharp/ArmoniK.Api.Mock
dotnet run

Test Environment Summary

The test environment utilizes a mock endpoint to assert if the ArmoniK service has been triggered. It leverages the requests library to query the /calls.json endpoint, examining the JSON response to validate the count of remote procedure calls made to specific services and methods

curl localhost:5000/calls.json | jq

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

armonik-3.15.2.dev1576.tar.gz (76.4 kB view details)

Uploaded Source

Built Distribution

armonik-3.15.2.dev1576-py3-none-any.whl (137.1 kB view details)

Uploaded Python 3

File details

Details for the file armonik-3.15.2.dev1576.tar.gz.

File metadata

  • Download URL: armonik-3.15.2.dev1576.tar.gz
  • Upload date:
  • Size: 76.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for armonik-3.15.2.dev1576.tar.gz
Algorithm Hash digest
SHA256 799587b12b94baede2dbf7a499c9fcd4dcfd2640ff0eb920069ae97b95fdf58d
MD5 9663c27a522361908942b5ad112ef3eb
BLAKE2b-256 2184f1138811765c05661954987683bed3ec298b881b343133aaa719a0bd15b2

See more details on using hashes here.

File details

Details for the file armonik-3.15.2.dev1576-py3-none-any.whl.

File metadata

File hashes

Hashes for armonik-3.15.2.dev1576-py3-none-any.whl
Algorithm Hash digest
SHA256 c17769af7dd0a62e5c6a694400bb38ab4f3a0ff052661ccf513ca946db21974b
MD5 9cebe1c9cf2b170d61a66bc500389fb2
BLAKE2b-256 f5361a154a9bbcc38a046b29c9dc0e6713ddfe6db4b69185b9873f6b0c7ab116

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page