Skip to content

Commit 0d6bd3f

Browse files
docs(readme): reorder quickstart examples
- Remove logging quickstart example - Present AWS, Cloudflare, Vault, then optional Kubernetes examples Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 491bb04 commit 0d6bd3f

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,14 @@ python3 -m pip install -e ".[kubernetes]"
6666

6767
## Quickstart
6868

69-
### Logging
69+
### AWS
7070

7171
```python
72-
from platform_core.utils import logger
72+
from platform_core.aws import AWSUtils
7373

74-
logger.info("hello from platform-core")
74+
aws = AWSUtils()
75+
sts = aws.create_boto3_client("sts", "us-east-1")
76+
print(sts.get_caller_identity()["Account"])
7577
```
7678

7779
### Cloudflare API
@@ -98,20 +100,24 @@ data = client.read_credentials(secrets_engine="secret", secret_path="team/app/cr
98100
print(data)
99101
```
100102

101-
### AWS
103+
### Kubernetes (optional)
102104

103105
```python
104-
from platform_core.aws import AWSUtils
106+
from platform_core.kubernetes import create_api_client
105107

106-
aws = AWSUtils()
107-
sts = aws.create_boto3_client("sts", "us-east-1")
108-
print(sts.get_caller_identity()["Account"])
108+
api_client = create_api_client()
109+
110+
# Requires: python3 -m pip install -e ".[kubernetes]"
111+
from kubernetes import client as k8s_client
112+
113+
v1 = k8s_client.CoreV1Api(api_client)
114+
print([ns.metadata.name for ns in v1.list_namespace().items])
109115
```
110116

111117
## Modules
112118

113119
- **`platform_core.utils`**
114-
- Logger setup + small helpers
120+
- Core helpers (logging, JSON, env, string utilities)
115121
- **`platform_core.aws`**
116122
- `AWSUtils` and helper managers (DynamoDB/SQS)
117123
- **`platform_core.cloudflare`**

0 commit comments

Comments
 (0)