Skip to content

Commit f725df5

Browse files
committed
Update README.md
1 parent 93db46a commit f725df5

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,30 @@
22

33
The Infisical SDK provides a convenient way to interact with the Infisical API.
44

5-
## Requirements
6-
7-
Python 3.7+
8-
9-
## Installation
10-
11-
```bash
12-
pip install infisicalsdk
13-
```
14-
15-
16-
## Migrating to stable version >= 1.0.0
5+
### Migrating to stable version >= 1.0.0
176

187
We have recently rolled out our first stable version of the SDK, version `1.0.0` and above.
198

209
The 1.0.0 version comes with a few key changes that may change how you're using the SDK.
2110
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).
11+
2212
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.
13+
2314
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`.
2415

2516
With this in mind, you're ready to upgrade your SDK version to `1.0.0` or above.
2617

27-
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
18+
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.
19+
20+
## Requirements
21+
22+
Python 3.7+
2823

24+
## Installation
25+
26+
```bash
27+
pip install infisicalsdk
28+
```
2929

3030
## Getting Started
3131

0 commit comments

Comments
 (0)