diff --git a/CHANGELOG.md b/CHANGELOG.md index 69c139f..20396d5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Added + +- Add `datacrunch` -> `verda` migration guide + ## [1.17.3] - 2025-11-27 ### Fixed diff --git a/MIGRATION.md b/MIGRATION.md new file mode 100644 index 0000000..e8194b6 --- /dev/null +++ b/MIGRATION.md @@ -0,0 +1,57 @@ +### Migration from `datacrunch` to `verda` + +On November 2025 [DataCrunch company changed its name to Verda](https://verda.com/blog/datacrunch-is-changing-its-name-to-verda). Starting with version 1.17.0, `verda` is the new name for the Python package. + +Original `datacrunch` package is deprecated, but we will continue maintaining it, publishing new `datacrunch` releases together with the new `verda` releases using the same version numbers. + +### Migration guide + +While we plan to continue maintaining `datacrunch` package, we recommend migrating to `verda`. Except for import changes, API is the same. + +Follow these steps to migrate: + +1. Replace `datacrunch` dependency with latest `verda` + + ``` + # if your project uses uv + uv remove datacrunch + uv add verda + + # if your project uses pip + pip uninstall datacrunch + pip install verda + ``` + +2. Replace `datacrunch` module with `verda` and `DataCrunchClient` class with `VerdaClient` + + ```python + # Before + from datacrunch import DataCrunchClient + from datacrunch.exceptions import APIException + try: + datacrunch = DataCrunchClient(...) + datacrunch.instances.create(...) + except APIException as exception: + print('error', exception) + + # After + from verda import VerdaClient + from verda.exceptions import APIException + try: + verda = VerdaClient(...) + verda.instances.create(...) + except APIException as e: + print('error', e) + ``` + +3. Change deep imports from `datacrunch.*.*` to `verda.*` + + ```python + # Before + from datacrunch.InferenceClient.inference_client import AsyncStatus + from datacrunch.instances.instances import Instance + + # After + from verda.inference_client import AsyncStatus + from verda.instances import Instance + ``` diff --git a/README.md b/README.md index 0316b52..1fdba1f 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ The SDK's documentation is available on [ReadTheDocs](https://datacrunch-python. Verda Public API documentation [is available here](https://api.verda.com/v1/docs). +This package was originally published under `datacrunch` name, see [MIGRATION.md](./MIGRATION.md) for details. + ## Getting Started - Using the SDK: - Install: @@ -39,7 +41,6 @@ Verda Public API documentation [is available here](https://api.verda.com/v1/docs ``` - To enable sending inference requests from SDK you must generate an inference key - [Instructions on inference authorization](https://docs.verda.com/inference/authorization) - - Add your inference key to an environment variable @@ -52,8 +53,6 @@ Verda Public API documentation [is available here](https://api.verda.com/v1/docs Other platforms: https://en.wikipedia.org/wiki/Environment_variable - - - Example for creating a new instance: ```python diff --git a/datacrunch_compat/datacrunch/__init__.py b/datacrunch_compat/datacrunch/__init__.py index c1e5aea..08d0de2 100644 --- a/datacrunch_compat/datacrunch/__init__.py +++ b/datacrunch_compat/datacrunch/__init__.py @@ -47,7 +47,7 @@ import warnings warnings.warn( - 'datacrunch is deprecated; use verda package instead: https://github.com/verda-cloud/sdk-python/blob/master/CHANGELOG.md#1170---2025-11-26', + 'datacrunch is deprecated; use verda package instead: https://github.com/verda-cloud/sdk-python/blob/master/MIGRATION.md', DeprecationWarning, stacklevel=2, ) diff --git a/datacrunch_compat/datacrunch/datacrunch.py b/datacrunch_compat/datacrunch/datacrunch.py index 61d55b2..f14f0e3 100644 --- a/datacrunch_compat/datacrunch/datacrunch.py +++ b/datacrunch_compat/datacrunch/datacrunch.py @@ -34,11 +34,3 @@ 'VolumesService', '__version__', ] - -import warnings - -warnings.warn( - 'datacrunch is deprecated; use verda package instead: https://github.com/verda-cloud/sdk-python/blob/master/CHANGELOG.md#1170---2025-11-26', - DeprecationWarning, - stacklevel=2, -)