cryoet-data-portal-python-client: v4.0.0

4.0.0 (2024-10-30)

⚠ BREAKING CHANGES

• Initial support for apiv2 (#1085)

✨ Features

• Initial support for apiv2 (#1085) (fec4000)

cryoet-data-portal-python-client: v3.1.1

3.1.1 (2024-10-28)

📝 Documentation

• Move documentation site to Sphinx Immaterial (#1087) (5d549dc)

cryoet-data-portal-python-client: v3.1.0

3.1.0 (2024-08-22)

✨ Features

• add user agent to client requests (#966) (8209cd4)
• Generate Python client code using GraphQL introspection (#1008) (35b7265)

🐞 Bug Fixes

• create recursive_from_prefix path if it does not exist (#940) (0069f08)
• Use match with substring for exception check in client tests (#895) (07352ec)
• wait for graphql to be healthy in client tests (#1044) (65f0a4b), closes #942

🧹 Miscellaneous Chores

• Add additional test case to TestGetDestinationPath (#955) (a9412a8)
• add instructions and commands to manually release the python package. (#1073) (4833eb9)
• automate release of python client (#972) (073bff7)

v3.0.2

What's Changed

• fix: update client tomogram documentation by @manasaV3 in #560
• chore: Updates to find method docs. by @jgadling in #615
• chore: docs formatting fixes by @jgadling in #616
• fix: Don't dowload too many annotation metadata files by @jgadling in #639
• chore: Updating client for new db fields by @manasaV3 in #634
• fix: Raise exception when attempting to filter on related objects. by @jgadling in #642

Full Changelog: v3.0.1...v3.0.2

v3.0.1

What's Changed

• Improve type hints for the client by @jgadling in #427
• Add missing documentation for TiltSeries fields. by @jgadling in #452

Full Changelog: v3.0.0...v3.0.1

v2.0.0

This version of the Python API represents a breaking change from v1, which was mostly needed to accommodate handling multiple annotation types and formats. See more details below.

What's New

• Added AnnotationFile to allow multiple annotation files in Annotation.files.
• Added TomogramAuthor to describe multiple authors in Tomogram.authors.
• Dataset
  • Added cell_component_name and cell_component_id.
  • Added key_photo_url and key_photo_thumbnail_url.
• DatasetAuthor
  • Added author_list_order.
• Tomogram
  • Added key_photo_url and key_photo_thumbnail_url.
  • Added offset_x, offset_y, and offset_z.
  • Added affine_transformation_matrix.
  • Added type.
  • Added neuroglancer_config.
• Annotation
  • Added shape and format arguments to Annotation.download.

Breaking Changes

• Tomogram
  • Removed downsampled MRC volume URLs: https_mrc_scale1, https_mrc_scale2, s3_mrc_scale1, s3_mrc_scale2.
  • Removed binning keyword argument from Tomogram.download_mrcfile.
• Annotation
  • Removed annotation path URLs:https_annotations_path, s3_annotations_path and moved to AnnotationFile.https_path and AnnotationFile.s3_path.
  • Removed shape_type and moved to AnnotationFile.
  • Removed object_width, object_weight, and object_diameter.

Full changelog: v1.0.1...v2.0.0

v3.0.0

What's Changed

• Set up a full local test infrastructure for testing the CLI by @jgadling in #410
• [breaking] Updates the client to return lists instead of generators for all find() and n:many relationships by @jgadling in #412

New Contributors

• @aganders3 made their first contribution in #294

Full Changelog: v2.0.0...v3.0.0

v1.0.1

fix: Fix model get_by_id

Full Changelog: v1.0.0...v1.0.1

v1.0.0

What's Changed

• BREAKING CHANGE: adjust the data model to support tomograms of multiple sizes by @jgadling in #4

Full Changelog: v0.0.2...v1.0.0

v0.0.1

Initial release

• Query the GraphQL API
• Traverse relationships between models
• Apply nested filters to when looking for data
• Download files from S3 and HTTPS