Skip to content

Commit 9eb8513

Browse files
Update README.md
1 parent 46bd8b9 commit 9eb8513

1 file changed

Lines changed: 30 additions & 2 deletions

File tree

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# ionic-python-sdk
2-
The Machina Tools SDK for Python provides an easy-to-use interface for developers to build client interfaces that interact with the Ionic Machina. See Machina Developers for more information.
1+
# Ionic Python SDK
2+
3+
## Overview
4+
This module provides Python developers with access to the core services of the Ionic Platform. At a high level, the platform provides developers with straightforward methods to
5+
* Securely create and retrieve data protection keys
6+
* Use these keys to encrypt or decrypt application data
7+
* Encrypt or decrypt arbitrary files
8+
* Enroll users and devices with the Ionic backend system.
9+
10+
## Quick Start
11+
Once you have access to an Ionic account (sign up for free at our [developer portal](https://ionic.com/developers/)), the Python environment makes it very simple to access some central features of the platform. The example below assumes you have already enrolled your system and have a default peristor.
12+
13+
```python
14+
import ionicsdk # top level module for all Ionic classes
15+
16+
plaintext = "Welcome to the Python SDK" # create some text to encrypt
17+
agent = ionicsdk.Agent() # the "Agent" class provides access to several common services.
18+
19+
cipher = ionicsdk.ChunkCipherV1(agent) # a "cipher" object provides "encrypt" and "decrypt" operations.
20+
# it uses the supplied "agent" to create and retrieve keys.
21+
ciphertext = cipher.encryptstr(plaintext)
22+
print ciphertext
23+
decrypted = cipher.decryptstr(ciphertext)
24+
print decrypted
25+
```
26+
27+
## Additional Information
28+
The Ionic Python SDK distribution includes online documentation for the classes and methods. You can review this documentation by browsing to the "index.html" file within the "docs" directory. It is also available online at the [Machina Python SDK Documentation](https://dev.ionic.com/sdk/docs/ionic_platform_sdk?language=python)
29+
30+
In order to use the SDK, you will need to enroll in one or more "Ionic tenants". If you don't already have an established tenant, you can create one for free at [the Ionic Machina Developer Portal](https://ionic.com/developers/), as well as find additional information, documentation, and community resources.

0 commit comments

Comments
 (0)