Skip to content

Commit 5226194

Browse files
committed
Remove doc portal links to pages that are not yet published
1 parent 3de08b7 commit 5226194

File tree

1 file changed

+20
-28
lines changed

1 file changed

+20
-28
lines changed

README.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
</p>
1010

1111
<p align="center">
12-
<a href="https://developer.1password.com/docs/sdks/">Documentation</a> | <a href="https://github.com/1Password/onepassword-sdk-python/tree/main/example">Examples</a>
12+
<a href="https://github.com/1Password/onepassword-sdk-python/tree/main/example">Examples</a>
1313
<br/>
1414

1515
---
@@ -28,31 +28,31 @@ Before you get started, [create a service account](https://developer.1password.c
2828

2929
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.
3030

31-
When managing items with 1Password SDKs, you must use [unique identifiers (IDs)](https://developer.1password.com/docs/sdks/concepts#unique-identifiers-ids) in place of vault, item, and field names.
31+
When managing items with 1Password SDKs, you must use unique identifiers (IDs) in place of vault, item, and field names.
3232

3333
## 🚀 Get started
3434

3535
To use the 1Password Python SDK in your project:
3636

3737
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:
38-
39-
**macOS or Linux**
40-
41-
```bash
42-
export OP_SERVICE_ACCOUNT_TOKEN=<your-service-account-token>
43-
```
44-
45-
**Windows**
46-
47-
```powershell
48-
$Env:OP_SERVICE_ACCOUNT_TOKEN = "<your-service-account-token>"
49-
```
38+
39+
**macOS or Linux**
40+
41+
```bash
42+
export OP_SERVICE_ACCOUNT_TOKEN=<your-service-account-token>
43+
```
44+
45+
**Windows**
46+
47+
```powershell
48+
$Env:OP_SERVICE_ACCOUNT_TOKEN = "<your-service-account-token>"
49+
```
5050

5151
2. Install the 1Password Python SDK in your project:
5252

53-
```bash
54-
pip install git+ssh://[email protected]/1Password/onepassword-sdk-python.git
55-
```
53+
```bash
54+
pip install git+ssh://[email protected]/1Password/onepassword-sdk-python.git
55+
```
5656

5757
3. Use the Python SDK in your project:
5858

@@ -64,10 +64,10 @@ from onepassword.client import Client
6464
async def main():
6565
# Gets your service account token from the OP_SERVICE_ACCOUNT_TOKEN environment variable.
6666
token = os.getenv("OP_SERVICE_ACCOUNT_TOKEN")
67-
67+
6868
# Connects to 1Password.
6969
client = await Client.authenticate(auth=token, integration_name="My 1Password Integration", integration_version="v1.0.0")
70-
70+
7171
# Retrieves a secret from 1Password. Takes a secret reference as input and returns the secret to which it points.
7272
value = await client.secrets.resolve("op://vault/item/field")
7373
# use value here
@@ -79,12 +79,4 @@ if __name__ == '__main__':
7979

8080
Make sure to use [secret reference URIs](https://developer.1password.com/docs/cli/secrets-reference-syntax/) with the syntax `op://vault/item/field` to securely load secrets from 1Password into your code.
8181

82-
Inside ```Client.authenticate(...)```, set ```integration_name``` to the name of your application and ```integration_version``` to the version of your application.
83-
84-
## 📖 Learn more
85-
86-
- [Load secrets with 1Password SDKs](https://developer.1password.com/docs/sdks/load-secrets)
87-
- [Manage items with 1Password SDKs](https://developer.1password.com/docs/sdks/manage-items)
88-
- [1Password SDK concepts](https://developer.1password.com/docs/sdks/concepts)
89-
90-
82+
Inside `Client.authenticate(...)`, set `integration_name` to the name of your application and `integration_version` to the version of your application.

0 commit comments

Comments
 (0)