beta-1.2.0-2024-04-23

Changes

• All Lock API Interfaces no longer uses iteration based polling nor will it fallback to iteration based polling. Lock API Interfaces are now based on the flock system calls and hence will only work on unix based systems.

dev-1.1.0-2024-03-08

Added the following new commands :

• module rename
  Renames the module safely

• module reversion
  Reversion the module safely

• module container validate
  Checks if the dockerfile is written with the correct permission, this checks that the dockerfile will not be run as root

• module container deploy
  Deploys the container to a registry, this will ask for confirmation once before deploying.

• module container deploy noconfirm
  Deploys the container to a registry without confirmation.

dev-1.0.1-2024-02-13

Brief Description 📝

This release removes the manifest-validate.json file in favour of a network hosted validator file. Additionally, this release updates the manifest file with new fields as specified by the manifest release statement

New Features 🚀

• Network Hosted Manifest File

Removal Warning ⚠️

• The components tag inside simple and advanced have now been removed.
• People using components before to render NGL Files should now upgrade to using a form field by specifying protein-representations and ngl-box.

prod-1.0.0-2024-02-01

Brief Description 📝

This is the initial release for the module_api. All modules are expected to upgrade to this version for generalization of the module-api. This includes all the latest changes and deprecation for module-api.

Version : 1.0.0

New Features 🚀

User of v0.0.19 or lower

• The module CLI is included with the install of module-api
• GPU Support for module api

Users of v0.0.20 or higher

• You can now get name of the generated container through the CLI
• GPU Support when using the CLI by modifying the module.lock file.

Bug Fixes 🐛

• module.lock will be created everytime even when an error occurs. This is now fixed.

Deprecation Warning ⚠️

• Users using v0.0.19 or lower, Runnable have been deprecated for a better design.
  You can update your code to the new version or replace :

from module_api.API.runnable import Runnable

with

from module_api.API.runnable.compat.v0 import Runnable

Note that only Runnable is changed, other exceptions or utils has not been changed in any way.

Additional Notes 📘

If you have been using v0.0.19, the Runnable version you are using have been deprecated and is moved to a compat folder and will be deleted. You are advised to upgrade as this version of Runnable is more

Production Use

• 0.0.20 : Hotfix a bug where changes files might not be deleted after usage.
• 0.0.20 : Removed the Hotfix

Nightly Release

Nightly Builds :
Description :
0.0.18 -> before version 2 error file
0.0.19 -> after version 2 error file with WARNING and ERROR
0.0.20 -> Added module generation tool
0.0.26 -> New Runnable, Old Runnable is provided as a compatibility by doing from module_api.API.runnable.compat.v0 import Runnable

Version 1.0.0

Features

• Testing with GPU
• Remove lockfile when created without a reason (auto created)
• Get container name from the command line