Skip to content

Commit

Permalink
Fix python doc links (#8)
Browse files Browse the repository at this point in the history
* Fix python doc links

* Add an initial changelog entry
  • Loading branch information
skeet70 authored Nov 16, 2023
1 parent c38cdeb commit e9b333e
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 2 deletions.
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## 0.9.0

Initial release of Alloy. This library is intended to eventually replace the Tenant Security Client libraries, and include additional functionality. Right now this includes:

- our standard (probabilistic, fully random) encryption
- deterministic encryption
- Cloaked AI vector encryption

All three of these support standalone and SaaS Shield modes in this SDK.

Notable features coming soon:
- SaaS Shield security events
- backwards compatibility with TSC libraries
- batch APIs
- rekey and rotate functionality

### Compatibility

Requires TSP 4.12.0+.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Ironcore Alloy SDK is designed to be a single SDK for all the different IronCore

- [Java](http://todo.com)
- [Kotlin](http://todo.com)
- [Python](http://todo.com)
- [Python](https://pypi.org/project/ironcore-alloy)
- [Rust](http://todo.com)

This SDK was written in Rust and is using [uniffi](https://github.com/mozilla/uniffi-rs) to generate the foreign language bindings. If your language is not listed above, feel free to open an issue and we can take a look!
Expand Down
2 changes: 1 addition & 1 deletion python/ironcore-alloy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![PyPI - Version](https://img.shields.io/pypi/v/ironcore-alloy.svg)](https://pypi.org/project/ironcore-alloy)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ironcore-alloy.svg)](https://pypi.org/project/ironcore-alloy)

Python bindings to the IronCore Labs Alloy SDK. Generated library API documentation hopefully incoming.
Python bindings to the IronCore Labs Alloy SDK. Python API documentation is available [here](https://ironcore-alloy.readthedocs.io). General documentation of the various products and broader information about how to use the SDK is available [here](https://docs.ironcorelabs.com).

- [Installation](#installation)
- [License](#license)
Expand Down

0 comments on commit e9b333e

Please sign in to comment.