Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Software Platform Modernization (tools) #105

Draft
wants to merge 14 commits into
base: develop
Choose a base branch
from
Draft

[WIP] Software Platform Modernization (tools) #105

wants to merge 14 commits into from

Conversation

nfrasser
Copy link
Member

@nfrasser nfrasser commented Dec 12, 2024

  • Drop python 3.7 support
  • New and improved API client
  • Formal model definitions

@nfrasser nfrasser self-assigned this Dec 12, 2024
Copy link

vercel bot commented Dec 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
cryosparc-tools ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 5:48pm

Reached end-of-life over a year ago and  no longer supported by our upcoming dependencies
* better type checking
* additional related type fixes
* additional logic and consistency fixes
Uses openapi schema to generate a client class

Also includes
- improved media type implementation for streams - better compatibility with fastapi
- stub token model - first generated model from CryoSPARC. Other models will come later
If given a list of enums, it should encode their values
Don't put these in query params or headers
Use model_validate instead of __init__ when parsing JSON from the API to ensure that special model validators which use a different type have their results intepreted correctly by pydantic
Interface remains largely the same, with some deprecations and changes to return values for asset endpoints

* update unit tests to work with new api client: Mocks client functions rather than API requests. This is not the greatest, but mocking the HTTP requests would have been way more complicated
* stream, dataset and type fixes
* python 3.8 correct import and type issues
* additional async dump stream helpers
* update api and model types
* initial changelog
* improved stream protocol names
* docstring updates and improvements
* clear_cached_property for convenience
Move everything relevant into submodules, as per review feedback at #114 (comment)
* fix(tools): various bugs in new API integration
* docs(tools): notebook fixes to work with updated APIs
* docs(tools): README and CHANGELOG update
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant