Skip to content

Commit 1a35861

Browse files
authored
Merge pull request #76 from 1Password/lucy/readme-update
Update README to simplify service account creation instructions
2 parents 34d0198 + 11d6bc2 commit 1a35861

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
The 1Password Python SDK offers programmatic access to your secrets in 1Password with Python. During the beta, you can create, retrieve, update, and delete items and resolve secret references.
1818

19+
1Password SDKs support authentication with [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/).
20+
1921
## Requirements
2022

2123
The 1Password Python SDK requires:
@@ -25,12 +27,6 @@ The 1Password Python SDK requires:
2527

2628
If you're running a Linux distribution that still uses `libssl` version 1.1.1, such as Debian 11 or Ubuntu 20.04, you'll need to update to a later version of Linux or install the required dependencies.
2729

28-
## 🔑 Authentication
29-
30-
1Password SDKs support authentication with [1Password Service Accounts](https://developer.1password.com/docs/service-accounts/get-started/).
31-
32-
Before you get started, [create a service account](https://developer.1password.com/docs/service-accounts/get-started/#create-a-service-account) and give it the appropriate permissions in the vaults where the items you want to use with the SDK are saved.
33-
3430
## ❗ Limitations
3531

3632
1Password SDKs don't yet support using secret references with query parameters, so you can't retrieve file attachments or SSH keys, or get more information about field metadata.
@@ -43,7 +39,8 @@ When managing items with 1Password SDKs, you must use [unique identifiers (IDs)]
4339

4440
To use the 1Password Python SDK in your project:
4541

46-
1. Provision your [service account](#authentication) token. We recommend provisioning your token from the environment. For example, to export your token to the `OP_SERVICE_ACCOUNT_TOKEN` environment variable:
42+
1. [Create a service account](https://my.1password.com/developer-tools/infrastructure-secrets/serviceaccount/) and give it the appropriate permissions in the vaults where the items you want to use with the SDK are saved.
43+
2. Provision your service account token. We recommend provisioning your token from the environment. For example, to export your token to the `OP_SERVICE_ACCOUNT_TOKEN` environment variable:
4744

4845
**macOS or Linux**
4946

@@ -57,13 +54,13 @@ To use the 1Password Python SDK in your project:
5754
$Env:OP_SERVICE_ACCOUNT_TOKEN = "<your-service-account-token>"
5855
```
5956

60-
2. Install the 1Password Python SDK in your project:
57+
3. Install the 1Password Python SDK in your project:
6158

6259
```bash
6360
pip install git+ssh://[email protected]/1Password/[email protected]
6461
```
6562

66-
3. Use the Python SDK in your project:
63+
4. Use the Python SDK in your project:
6764

6865
```python
6966
import asyncio

0 commit comments

Comments
 (0)