Skip to content

Commit 7312d8f

Browse files
jamesponddotcotjunnone
authored andcommitted
Update README to match the Go SDK
Signed-off-by: James Pond <[email protected]>
1 parent 1e4e934 commit 7312d8f

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,28 @@
11
# Cloudcraft API Client for Python
22

33
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache2.0-yellow.svg)](LICENSE.md)
4-
[![versions](https://img.shields.io/pypi/pyversions/pybadges.svg)](https://www.python.org/downloads/release/python-3100/)
4+
[![versions](https://img.shields.io/pypi/pyversions/cloudcraftco)](https://www.python.org/downloads/release/python-3100/)
55
[![Build Status](https://github.com/cloudcraft/cloudcraft-python/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/cloudcraft/cloudcraft-python/actions?query=branch%3Amain)
66

7-
The Cloudcraft Python library provides convenient access to the Cloudcraft API from
8-
applications written in Python.
7+
![Cloudcraft diagram](https://static.cloudcraft.co/sdk/cloudcraft-sdk-example-1.svg)
98

10-
## Requirements
9+
Visualize your cloud architecture with Cloudcraft by Datadog, [the best way to create smart AWS and Azure diagrams](https://www.cloudcraft.co/).
10+
11+
Cloudcraft supports both manual and programmatic diagramming, as well as automatic reverse engineering of existing cloud environments into
12+
beautiful system architecture diagrams.
13+
14+
This `cloudcraftco` Python library provides an easy-to-use native Python SDK for interacting with [the Cloudcraft API](https://developers.cloudcraft.co/).
1115

12-
Client requirement...
16+
Use case examples:
17+
- Snapshot and visually compare your live AWS or Azure environment before and after a deployment, in your app or as part of your automated CI pipeline
18+
- Download an inventory of all your cloud resources from a linked account as JSON
19+
- Write a converter from a third party data format to Cloudcraft diagrams
20+
- Backup, export & import your Cloudcraft data
21+
- Programmatically create Cloudcraft diagrams
22+
23+
This SDK requires a [Cloudcraft API key](https://developers.cloudcraft.co/#authentication) to use. [A free trial of Cloudcraft Pro](https://www.cloudcraft.co/pricing) with API access is available.
24+
25+
## Requirements
1326

1427
- Python 3.10
1528
- Requests 2.28
@@ -19,15 +32,10 @@ Client requirement...
1932
```
2033
python -m pip install cloudcraftco
2134
```
22-
[TBD - standard pypi install, package name is preliminary]
23-
[see https://docs.python.org/3/installing/index.html]
2435

2536
## Usage
2637

27-
The API is accessed through the `Cloudcraft` class. An API key available through
28-
the Cloudcraft user interface is required when instantiating `Cloudcraft`. It
29-
can be passed to the class as an argument or through the `CLOUDCRAFT_API_KEY`
30-
environment variable:
38+
The API is accessed through the `Cloudcraft` class. An API key available through the Cloudcraft user interface is required when instantiating `Cloudcraft`. It can be passed to the class as an argument or through the `CLOUDCRAFT_API_KEY` environment variable:
3139

3240
```python
3341
from cloudcraftco import Cloudcraft

0 commit comments

Comments
 (0)