Client and Protocols for DARPA sail-on
Project description
Sail-On Client and Protocols
Client and Protocols for DARPA sail-on
Protocols present in the repository
Requirements
Installation
-
Install Poetry following the instructions available in the installation page
-
Clone the repositories associated with different components in a working directory
git clone https://github.com/darpa-sail-on/sail-on-client.git
This would create sail-on-client directories in your working directory
-
Install the different components in a virtual environment
cd sail-on-client poetry install poetry shell
Running Client and Server with Different Algorithms
Note: If you are using the server setup by PAR, update the url
to http://3.32.8.161:5000
in sail_on_client/protocol/configuration.json and skip step 1 of running the server.
- Instructions for running M6 Algorithms
- Instructions for running M12 Algorithms
- Instructions for running M18 Algorithms
Publishing on PYPI
sail-on-client uses github actions to publish packages on pypi. The action is triggered when a semver tag is pushed to the repository.
We support the following version format .. and ..-alpha. for tags. To publish a package on pypi, the tag must match with the version maintained in pyproject.toml. This is implemented as a mandatory check in the workflow. Poetry provides support for both querying and bumping version via cli. Please refer to version for more details.
Thus to publish sail-on-client on pypi use the following commands
- Bump the version in pyproject.toml using
poetry version <version_rule>
. - Use poetry version --short to determine the version that would be used in the tag.
- Generate and push the tag using
git tag <package-version> git push origin --tags
Acknowledgement of Support and Disclaimer
This material is based upon work supported by the Defense Advanced Research Projects Agency (DARPA) under Contract No. HR001120C0055. Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the DARPA.
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
Built Distribution
File details
Details for the file sail-on-client-0.30.0.tar.gz
.
File metadata
- Download URL: sail-on-client-0.30.0.tar.gz
- Upload date:
- Size: 50.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.11 CPython/3.7.13 Linux/5.13.0-1022-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f24a14eaf804b6bcdb57b67aa377b4a1d3ff741106b33bac1315eea0868b5fe |
|
MD5 | 1c4738ff78771f7b39d00589498f5e19 |
|
BLAKE2b-256 | 83cceead07c7ee130118eedfe07100c7d2fc0b67f4e9f8b4c96817cc3337ff49 |
Provenance
File details
Details for the file sail_on_client-0.30.0-py3-none-any.whl
.
File metadata
- Download URL: sail_on_client-0.30.0-py3-none-any.whl
- Upload date:
- Size: 92.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.11 CPython/3.7.13 Linux/5.13.0-1022-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 646f02d574cbc2239b81b508e7bb7321fe1df640afb8bd6cae6251e32e2ff362 |
|
MD5 | 9645c96d0a49e0bb4967fc68c303c58f |
|
BLAKE2b-256 | 0dfc15ba55953a21e286cb275c3d52924821cc0f8235b4c6f356b78f64516306 |