Skip to content

Commit 75c0a40

Browse files
author
Lucas McDonald
committed
m
1 parent c801b42 commit 75c0a40

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Python AWS Database Encryption SDK for DynamoDB
2+
3+
[![MPL-python-tests](https://github.com/aws/aws-database-encryption-sdk-dynamodb/actions/workflows/push.yml/badge.svg)](https://github.com/aws/aws-database-encryption-sdk-dynamodb/actions/workflows/push.yml)
4+
5+
[![Code style: black](https://img.shields.io/badge/code_style-black-000000.svg)](https://github.com/ambv/black)
6+
7+
[![Documentation Status](https://readthedocs.org/projects/aws-dbesdk-dynamodb-python/badge/)](https://aws-dbesdk-dynamodb-python.readthedocs.io/en/latest/)
8+
9+
These are the docs for the Python AWS Database Encryption SDK for DynamoDB.
10+
11+
The latest full documentation can be found at [Read the Docs](https://aws-dbesdk-dynamodb-python.readthedocs.io/en/latest/).
12+
13+
Find us on [GitHub](https://github.com/aws/aws-database-encryption-sdk-dynamodb).
14+
15+
## Security
16+
17+
If you discover a potential security issue in this project
18+
we ask that you notify AWS/Amazon Security via our
19+
[vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/).
20+
Please **do not** create a public GitHub issue.
21+
22+
## Getting Started
23+
24+
### Required Prerequisites
25+
26+
* Python 3.11+
27+
* aws-cryptographic-material-providers 1.10.0+
28+
29+
### Installation
30+
31+
> **Note:**
32+
> If you have not already installed [cryptography](https://cryptography.io/en/latest/), you might need to install additional prerequisites as
33+
> detailed in the [cryptography installation guide](https://cryptography.io/en/latest/installation/) for your operating system.
34+
35+
```bash
36+
$ pip install aws-dbesdk-dynamodb
37+
```
38+
39+
### Concepts
40+
41+
The AWS Database Encryption SDK for DynamoDB (DBESDK-DynamoDB) is available in multiple languages.
42+
The concepts in the Python implementation of the DBESDK-DynamoDB are the same as in other languages.
43+
For more information on concepts in the DBESDK-DynamoDB, see the [README](https://github.com/aws/aws-database-encryption-sdk-dynamodb/blob/main/README.md) for all languages.
44+
45+
DBESDK-DynamoDB uses cryptographic material providers from the AWS Cryptographic Material Providers Library (MPL).
46+
For more information on the MPL, see its [README](https://github.com/aws/aws-database-encryption-sdk-dynamodb/blob/main/README.md) or [readthedocs](https://aws-cryptographic-material-providers-library.readthedocs.io/en/latest/) page.

0 commit comments

Comments
 (0)