1.7.0

• (#71) Added support for instrument types:
  • Added a new InstrumentType class
  • Modified the Instrument class to return InstrumentType objects when reading the instrument_type property
  • Modified the StepDetails class to return InstrumentType objects when reading the permitted_instrument_types property
  • Added a new instrument_types property to the LIMS class that can query instrument types.
  • The Instrument class now correctly reports instrument limsids.
  • The instrument_used property of StepDetails is now writable.
• Several updates to StepRunner:
  • (#69) Step runners now support running the same step multiple times within a protocol.
  • (#76) Step runners can now sign steps that require an eSignature, by calling self.sign() from the record_details() method.
• (#68) The "Leave in QC Protocol" artifact action can now be selected at the Next Steps screen by using step.actions.artifact_actions[artifact].leave_in_qc_protocol()
• (#67) The replace_and_commit_from_local method of the File class now supports an optional name parameter, allowing you to upload a file to Clarity using a different name from the on-disk filename.
• (#65) Fixes a bug in StepConfiguration.permitted_containers() that caused steps with no permitted containers (i.e. no-output steps) to return all container types instead of none.
• (#63) Added the Step.clear_pools() method which can be used to remove any existing pools that were created on a step.

1.6.1

• Explicitly declare requests >= 2.22.0 and urllib3 >= 1.25.2 as dependencies, which fixes an edge case causing the lims.versions and lims.current_minor_version properties to raise an exception on early versions of Python 3.6.

1.6.0

• Added support for Python 3.12.
• Step placements can now be updated without having to clear existing placements first.
• Fix an issue that prevented StepRunner.add_default_reagents() from working correctly on Clarity 6.1+ if the step being run contains an archived reagent kit.
• Fix an issue that could cause log messages to become duplicated, or disappear, when s4-clarity-lib is being used in tandem with an LLTK/LITK on the same step in Clarity 6.0+.
• Added lims.versions and lims.current_minor_version properties.

1.5.0

• Added the permitted_containers property to StepConfiguration.
• Added support for the Step Setup state to StepRunner.
• Improved Documentation, testing and function naming around container types and well ordering.

1.4.2

• Migrated CI/CD from Travis-CI to GitHub Actions.
• No code changes since 1.4.1, just pushing a release to verify that we can still deploy to PyPi!

1.4.1

• Fixed a typo that prevented the supplier property from being set on an instance of ReagentKit.

1.4.0

• Now fully compatible with Python 3.10.
• The insecure and dry-run parameters may now be used together when creating a LIMS object.

1.3.1

• Fixed regression in 1.3.0 which caused all stage-based routing to fail

1.3.0

• Added support for the Clarity Instruments API endpoint:
  • Added a new Instrument class
  • Updated StepConfiguration (in configuration.protcol) and StepDetails (in step) to retrieve instrument related xml subnodes
• Add a filessupport for Project
• Fixed bug workflow.enqueue() that generated an invalid post if stage appears in the domain name
• Removed dependency on typing for Python versions 3.5 and up
• Updated documentation:
  • The StepProgramStatus class documentation now more accurately reflects usage
  • The documentation of the Stage class has corrected to show that the step property returns a StepConfiguration object

1.2.0

Fix ClarityElement.repr to always return a string to avoid exceptions in Python 3.x
Fix incorrect universal tag for ControlType that prevented the creation of Control Types using the library
Add is_published property to the File object