v1.4.0

What's Changed

• Added support for Python 3.13. Added support for Galaxy release 24.1.

• Added user_agent parameter to the __init__() method of the GalaxyClient, GalaxyInstance and ToolShedInstance classes (thanks to Daniel Blankenberg).

• Added version and use_cached_job parameters to WorkflowClient.invoke_workflow() method (reported by Bérénice Batut).

• Changed the default values for the operation and default parameters of the QuotaClient.update_quota() method (thanks to Matthias Bernt).

• Improvements to tests and documentation (thanks to Matthias Bernt).

New Contributors

• @blankenberg made their first contribution in #318

Full Changelog: v1.3.0...v1.4.0

v1.3.0

What's Changed

• Dropped support for Python 3.7. Added support for Python 3.12. Added support for Galaxy releases 23.2 and 24.0.

• Added copy_elements parameter to HistoryClient.create_dataset_collection() and BioBlend.objects History.create_dataset_collection() methods.

• Added wait parameter to HistoryClient.delete_dataset() and BioBlend.objects HistoryDatasetAssociation.delete() methods.

• Added create_time_min, create_time_max, update_time_min, update_time_max, view, keys, limit and offset parameters to HistoryClient.get_histories() (thanks to cat-bro).

• Added create_time_min, create_time_max, update_time_min and update_time_max parameters to HistoryClient.get_published_histories() (thanks to cat-bro).

• Added keys parameter to HistoryClient.show_history() (thanks to cat-bro).

• Dropped broken deleted parameter of DatasetClient.show_dataset().

• Parameters after password in the __init__() method of the GalaxyClient, GalaxyInstance and ToolShedInstance classes are now keyword-only.

• Classes defined in bioblend.galaxy.objects.wrappers are no more re-exported by bioblend.galaxy.objects.

• DatasetTimeoutException and DatasetCollectionTimeoutException are now aliases for TimeoutException instead of subclasses.

• Added support for the new "cancelling" invocation state.

• Fixed InvocationClient.get_invocation_biocompute_object() method on upcoming Galaxy 24.1 .

• Improvements to linting and tests (thanks to Matthias Bernt).

Full Changelog: v1.2.0...v1.3.0

v1.2.0

• Dropped support for Galaxy releases 17.09-19.01. Added support for Galaxy release 23.1.

• Added a new container_resolution attribute to GalaxyInstance objects, which is an instance of the new ContainerResolutionClient. This new module can be used to list container resolvers, and to resolve (and install) tool requirements against specified container resolvers (thanks to cat-bro and Matthias Bernt).

• Added reload_toolbox() method to ConfigClient (thanks to Anthony Bretaudeau).

• Added delete_unused_dependency_paths() and unused_dependency_paths() methods to ToolDependenciesClient (thanks to Matthias Bernt).

• Added data_manager_mode parameter to ToolClient.run_tool() method (thanks to Marius van den Beek).

• Added user_data parameter to UserClient.update_user() method (thanks to Uwe Winter).

• Fixed bug in DatasetClient.download_dataset() and BioBlend.objects HistoryDatasetAssociation.get_stream() where the wrong download URL was generated if the Galaxy instance is served at a subdirectory (reported by Anil Thanki).

• Improvements to tests and documentation (thanks to kxk302 and Simon Bray).

v1.1.1

• Same as BioBlend v1.1.0, briefly released with wrong version number 1.0.1 on GitHub, PyPI and Bioconda.
• Added support for Python 3.11. Added support for Galaxy release 23.0.
• Using the deprecated folder_id parameter of the LibraryClient.get_folders() method now raises a ValueError exception.
• Using the deprecated library_id parameter of the LibraryClient.get_libraries() method now raises a ValueError exception.
• Using the deprecated tool_id parameter of the ToolClient.get_tools() method now raises a ValueError exception.
• Using the deprecated workflow_id parameter of the WorkflowClient.get_workflows() method now raises a ValueError exception.
• Modified delete_workflow() method of WorkflowClient to return None instead of a string.
• Add py.typed marker file to distributed packages (as per PEP 561) to declare type checking support.
• Improvements to tests and documentation.

v1.0.0

• Dropped support for deprecated CloudMan, see https://galaxyproject.org/blog/2021-10-sunsetting-cloudlaunch/

• Added dependency on typing-extensions package, removed dependencies on boto and pyyaml.

• Deprecated max_get_retries(), set_max_get_retries(), get_retry_delay() and set_get_retry_delay() methods of Client.

• Moved max_get_attempts and get_retry_delay properties from GalaxyInstance to GalaxyClient, so they are also available in ToolshedInstance.

• Added get_or_create_user_apikey() method to UserClient.

• Added all parameter to HistoryClient.get_histories() method (thanks to Paprikant).

• Added require_exact_tool_versions parameter to WorkflowClient.invoke_workflow() method (thanks to cat-bro).

• Added name and owner parameters to
  ToolShedRepositoryClient.get_repositories().

• Removed unused methods from bioblend.config.Config. If needed, use the methods inherited from configparser.ConfigParser instead.

• Allowed any 2XX HTTP response status code in Client._delete() to correctly support history purging via Celery (thanks to Nolan Woods).

• Fixed bug in FormsClient.create_form() where the form_xml_text argument was not passed correctly to the Galaxy API.

• Fixed bug in HistoryClient.show_dataset_provenance() where the follow argument was not passed to the Galaxy API.

• BioBlend.objects: Added delete() abstract method to DatasetContainer class.

• Added Code of Conduct for the project.

• Finished the full type annotation of the library (thanks to cat-bro, Fabio Cumbo, Jayadev Joshi, thepineapplepirate).

• Improvements to tests and documentation.

v0.18.0

• Added support for Galaxy release 22.05.

• Added tus support to ToolClient.upload_file() (thanks to Nate Coraor).

• Format Python code with black and isort.

• Improvements to type annotations, tests and documentation.

v0.17.0

• Dropped support for Python 3.6. Added support for Python 3.10. Added support for Galaxy releases 21.09 and 22.01.

• Removed deprecated run_workflow() method of WorkflowClient.

• Using the deprecated history_id parameter of the HistoryClient.get_histories() method now raises a ValueError exception.

• Made tool_inputs_update parameter of JobsClient.rerun_job() more flexible.

• Added whoami() method to ConfigClient (thanks to cat-bro).

• Added get_extra_files() method to HistoryClient.

• Added build() and reload() methods to ToolClient (thanks to Jayadev Joshi and cat-bro respectively).

• Added get_repositories() method to ToolShedCategoryClient (thanks to cat-bro).

• Added update_repository_metadata() method to ToolShedRepositoryClient.

• Added order_by parameter to JobsClient.get_jobs() method.

• BioBlend.objects: Removed deprecated run() method of Workflow.

• BioBlend.objects: Fail if multiple libraries/histories/workflows match when deleting by name, instead of deleting them all.

• BioBlend.objects: in HistoryDatasetAssociation.get_stream(), wait for the dataset to be ready.

• BioBlend.objects: in Workflow.invoke(), check that the workflow is mapped and runnable before invoking, allow the inputs parameter to be an instance of a Dataset subclass, and allow the history parameter to be the name of a new history.

• BioBlend.objects: Added new datasets and dataset_collections attributes to GalaxyInstance objects, which are instances of the new ObjDatasetClient and ObjDatasetCollectionClient respectively.

• BioBlend.objects: Added refresh(), get_outputs() and get_output_collections() methods to InvocationStep.

• Fixed error when instantiating GalaxyInstance with email and password (reported by Peter Briggs).

• Fixed parameter validation errors for POST requests with attached files on upcoming Galaxy 22.05.

• Code cleanups (thanks to Martmists).

• Improvements to type annotations, tests and documentation.

v0.16.0

• Added support for Galaxy release 21.05.

• Replaced the job_info parameter with separate tool_id, inputs and state parameters in JobsClient.search_jobs() (thanks to
  rikeshi).

• Pass the API key for all requests as the x-api-key header instead of as a parameter (thanks to rikeshi).

• Try prepending https:// and http:// if the scheme is missing in the url parameter of GalaxyClient, i.e. when initialising a Galaxy or ToolShed instance.

• Added a new dataset_collections attribute to GalaxyInstance objects, which is an instance of the new DatasetCollectionClient. This new module can be used to get details of a dataset collection, wait until elements of a dataset collection are in a terminal state, and download a history dataset collection as an archive (thanks to rikeshi).

• Added a new tool_dependencies attribute to GalaxyInstance objects, which is an instance of the new ToolDependenciesClient. This new module can be used to summarize requirements across toolbox (thanks to cat-bro).

• Added publish_dataset() update_permissions() and wait_for_dataset() methods to DatasetClient.

• Added get_invocation_biocompute_object(), get_invocation_report_pdf(), get_invocation_step_jobs_summary(), rerun_invocation() and wait_for_invocation() methods to InvocationClient (thanks to rikeshi).

• Added cancel_job(), get_common_problems(), get_destination_params(), get_inputs(), get_outputs(), resume_job(), show_job_lock(), update_job_lock() and wait_for_job() methods to JobsClient (thanks to Andrew Mcgregor and rikeshi).

• Added get_citations() and uninstall_dependencies() methods to ToolClient (thanks to rikeshi).

• Added extract_workflow_from_history(), refactor_workflow() and show_versions() methods to WorkflowClient (thanks to rikeshi).

• Added several parameters to DatasetClient.get_datasets() method (thanks to rikeshi).

• Added several parameters to InvocationClient.get_invocations() method (thanks to Nolan Woods and rikeshi).

• Added several parameters to JobsClient.get_jobs() method (thanks to rikeshi).

• Added parameters_normalized parameter to WorkflowClient.invoke_workflow() method (thanks to rikeshi).

• Deprecated folder_id parameter of LibraryClient.get_folders() method.

• Deprecated library_id parameter of LibraryClient.get_libraries() method.

• Deprecated tool_id parameter of ToolClient.get_tools() method.

• Deprecated workflow_id parameter of WorkflowClient.get_workflows() method.

• BioBlend.objects: Removed deprecated container_id property of Dataset and Folder objects.

• BioBlend.objects: Removed Preview abstract class.

• BioBlend.objects: Added invoke() method to Workflow. Added ObjInvocationClient, and Invocation and InvocationPreview wrappers (thanks to rikeshi).

• BioBlend.objects: Added latest_workflow_uuid property to Workflow objects. Added deleted, latest_workflow_uuid, number_of_steps, owner and show_in_tool_panel properties to WorkflowPreview (thanks to Nolan Woods).

• BioBlend.objects: Deprecated run() method of Workflow.

• Added use_ssl, verify and authuser parameters to CloudManInstance.__init__() (thanks to Nathan Edwards).

• Improvements to type annotations, tests and documentation (thanks to rikeshi).

v0.15.0

• Dropped support for Python 3.5. Added support for Python 3.9. Added support for Galaxy releases 20.09 and 21.01.

• Changed the return value of RolesClient.create_role() method from a 1-element list containing a dict to a dict.

• Removed deprecated download_dataset() and get_current_history methods of HistoryClient.

• Removed deprecated export_workflow_json() and import_workflow_json methods of WorkflowClient.

• Added copy_content(), get_published_histories() and open_history() methods to HistoryClient.

• Added rerun_job() method to JobsClient.

• Added requirements() method to ToolClient (thanks to cat-bro).

• Added published and slug parameters to HistoryClient.get_histories().

• Added require_state_ok parameter to DatasetClient.download_dataset().

• Added input_format parameter to ToolClient.run_tool().

• Deprecated history_id parameter of HistoryClient.get_histories() method.

• BioBlend.objects: Added owner property to all objects. Added annotation, published and purged properties to HistoryPreview
  objects.

• Fixed issue where specifying the Galaxy URL with "http://" instead of "https://" when creating a GalaxyInstance made the subsequent non-GET requests to silently fail.

• Moved the Continuous Integration (CI) from TravisCI to GitHub workflows (thanks to Oleg Zharkov).

• Improvements to tests and documentation (thanks to Gianmauro Cuccuru).

v0.14.0

• Dropped support for Python 2.7. Dropped support for Galaxy releases 14.10-17.05. Added support for Python 3.8. Added support for Galaxy releases 19.09, 20.01 and 20.05.

• Added a new invocations attribute to GalaxyInstance objects, which is an instance of the new InvocationClient class. This new module can be used to get all workflow invocations, show or cancel an invocation, show or pause an invocation step, get a summary or a report for an invocation (thanks to Simon Bray).

• Added get_datasets() method to DatasetClient (thanks to Simon Bray).

• Added import_history() method to HistoryClient (thanks to David Christiany and Marius van den Beek).

• Added copy_dataset() method to HistoryClient (thanks to Simon Bray).

• Added get_metrics() method to JobsClient (thanks to Andreas Skorczyk).

• Added report_error() method to JobsClient (thanks to Peter Selten).

• Added get_dataset_permissions() and set_dataset_permissions() methods to LibraryClient (thanks to Frederic Sapet).

• Added update_user() method to UserClient (thanks to Anthony Bretaudeau).

• Added update_workflow() method to WorkflowClient.

• Added tags parameter to upload_file_from_url(), upload_file_contents(), upload_file_from_local_path(), upload_file_from_server() and upload_from_galaxy_filesystem() methods
  of LibraryClient (thanks to Anthony Bretaudeau).

• Changed the default for the tag_using_filenames parameter of upload_file_from_server() and upload_from_galaxy_filesystem() methods of LibraryClient from True to False (thanks to Anthony Bretaudeau).

• Added version parameter to show_workflow() and export_workflow_dict() methods of WorkflowClient.

• Added inputs_by option to invoke_workflow() method of WorkflowClient (thanks to Marius van den Beek).

• Removed deprecated show_stderr() and show_stdout methods of DatasetClient.

• BioBlend.objects: Allowed workflow steps of type parameter_input and subworkflow. Added parameter_input_ids property to Workflow objects (reported by Nolan Woods).

• Fixed HistoryClient.export_history(..., wait=False, maxwait=None) (reported by David Christiany).

• Moved internal _make_url() method from GalaxyClient to Client class.