From 93db46a8463ecfcad620d4083d6ff0e6350bb1a5 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard Date: Wed, 8 Jan 2025 16:59:14 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 02ea8a2..4f6a8f2 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,21 @@ Python 3.7+ pip install infisicalsdk ``` + +## Migrating to stable version >= 1.0.0 + +We have recently rolled out our first stable version of the SDK, version `1.0.0` and above. + +The 1.0.0 version comes with a few key changes that may change how you're using the SDK. +1. **Removal of `rest`**: The SDK no longer exposes the entire Infisical API. This was nessecary as we have moved away from using an OpenAPI generator approach. We aim to add support for more API resources in the near future. If you have any specific requests, please [open an issue](https://github.com/Infisical/python-sdk-official/issues). +2. **New response types**: The 1.0.0 release uses return types that differ from the older versions. The new return types such as `BaseSecret`, are all exported from the Infisical SDK. +3. **Property renaming**: Some properties on the responses have been slightly renamed. An example of this would be that the `secret_key` property on the `get_secret_by_name()` method, has been renamed to `secretKey`. + +With this in mind, you're ready to upgrade your SDK version to `1.0.0` or above. + +You can refer to our [legacy documentation](https://github.com/Infisical/python-sdk-official/tree/9b0403938ee5ae599d42c5f1fdf9158671a15606?tab=readme-ov-file#infisical-python-sdk) if need be + + ## Getting Started ```python From f725df5c34f0b1cf53fdfdf0187cd0b287cc800a Mon Sep 17 00:00:00 2001 From: Daniel Hougaard Date: Wed, 8 Jan 2025 17:16:04 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4f6a8f2..d3ca161 100644 --- a/README.md +++ b/README.md @@ -2,30 +2,30 @@ The Infisical SDK provides a convenient way to interact with the Infisical API. -## Requirements - -Python 3.7+ - -## Installation - -```bash -pip install infisicalsdk -``` - - -## Migrating to stable version >= 1.0.0 +### Migrating to stable version >= 1.0.0 We have recently rolled out our first stable version of the SDK, version `1.0.0` and above. The 1.0.0 version comes with a few key changes that may change how you're using the SDK. 1. **Removal of `rest`**: The SDK no longer exposes the entire Infisical API. This was nessecary as we have moved away from using an OpenAPI generator approach. We aim to add support for more API resources in the near future. If you have any specific requests, please [open an issue](https://github.com/Infisical/python-sdk-official/issues). + 2. **New response types**: The 1.0.0 release uses return types that differ from the older versions. The new return types such as `BaseSecret`, are all exported from the Infisical SDK. + 3. **Property renaming**: Some properties on the responses have been slightly renamed. An example of this would be that the `secret_key` property on the `get_secret_by_name()` method, has been renamed to `secretKey`. With this in mind, you're ready to upgrade your SDK version to `1.0.0` or above. -You can refer to our [legacy documentation](https://github.com/Infisical/python-sdk-official/tree/9b0403938ee5ae599d42c5f1fdf9158671a15606?tab=readme-ov-file#infisical-python-sdk) if need be +You can refer to our [legacy documentation](https://github.com/Infisical/python-sdk-official/tree/9b0403938ee5ae599d42c5f1fdf9158671a15606?tab=readme-ov-file#infisical-python-sdk) if need be. + +## Requirements + +Python 3.7+ +## Installation + +```bash +pip install infisicalsdk +``` ## Getting Started From 0b595fde6d3d8eace0ff52257ad1933aaa77b19a Mon Sep 17 00:00:00 2001 From: Daniel Hougaard Date: Wed, 8 Jan 2025 17:16:46 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d3ca161..ae4d633 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The Infisical SDK provides a convenient way to interact with the Infisical API. -### Migrating to stable version >= 1.0.0 +### Migrating to version 1.0.0 or above We have recently rolled out our first stable version of the SDK, version `1.0.0` and above. From dbd82907ff4e4228dce61bab9a1e792ebf6ca1e8 Mon Sep 17 00:00:00 2001 From: Daniel Hougaard Date: Wed, 8 Jan 2025 17:17:49 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ae4d633..fa4b35a 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ The 1.0.0 version comes with a few key changes that may change how you're using 2. **New response types**: The 1.0.0 release uses return types that differ from the older versions. The new return types such as `BaseSecret`, are all exported from the Infisical SDK. -3. **Property renaming**: Some properties on the responses have been slightly renamed. An example of this would be that the `secret_key` property on the `get_secret_by_name()` method, has been renamed to `secretKey`. +3. **Property renaming**: Some properties on the responses have been slightly renamed. An example of this would be that the `secret_key` property on the `get_secret_by_name()` method, that has been renamed to `secretKey`. With this in mind, you're ready to upgrade your SDK version to `1.0.0` or above.