Skip to content

Commit 77c1452

Browse files
drernieclaude
andauthored
Add comprehensive authentication guide for API keys (#4701)
Co-authored-by: Claude <noreply@anthropic.com>
1 parent 0b2ee43 commit 77c1452

File tree

3 files changed

+577
-4
lines changed

3 files changed

+577
-4
lines changed

docs/Quickstart.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,29 @@ Explore production datasets with guided examples:
2828
pip install quilt3
2929
```
3030

31-
### 2. **Browse Public Data**
31+
### 2. **Authenticate (Optional for Public Data)**
32+
33+
For public datasets like `s3://quilt-example`, no authentication is needed. For private buckets or catalogs, choose your authentication method:
34+
35+
<!-- pytest-codeblocks:skip -->
36+
```python
37+
import quilt3
38+
39+
# Interactive login (for local development, notebooks)
40+
quilt3.login() # Opens browser for OAuth/SSO
41+
42+
# OR use an API key (for automation, CI/CD, scripts)
43+
import os
44+
quilt3.login_with_api_key(os.environ["QUILT_API_KEY"])
45+
```
46+
47+
**📚 Learn more**: See the [Authentication Guide](api-reference/authentication.md) for detailed setup instructions, best practices, and use cases.
48+
49+
### 3. **Browse Public Data**
3250
```python
3351
import quilt3
3452

35-
# Browse available datasets
53+
# Browse available datasets (no auth needed for public data)
3654
packages = list(quilt3.list_packages("s3://quilt-example"))
3755
print(f"Found {len(packages)} public datasets")
3856

@@ -41,7 +59,7 @@ pkg = quilt3.Package.browse("examples/hurdat", "s3://quilt-example")
4159
print(pkg)
4260
```
4361

44-
### 3. **Access Your First File**
62+
### 4. **Access Your First File**
4563
<!-- pytest-codeblocks:cont -->
4664
```python
4765
# Download and read a file (using pkg from previous step)
@@ -50,7 +68,7 @@ content = data_file.get()
5068
print(content)
5169
```
5270

53-
### 4. **Create Your First Package**
71+
### 5. **Create Your First Package**
5472
```python
5573
import quilt3
5674
import tempfile

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
* [Local Catalog](Catalog/LocalMode.md)
6363
* [CLI, Environment](api-reference/cli.md)
6464
* [Known Limitations](api-reference/limitations.md)
65+
* [Authentication Guide](api-reference/authentication.md)
6566
* [Custom SSL Certificates](api-reference/custom-ssl-certificates.md)
6667
* **Advanced**
6768
* [Browsing Buckets](walkthrough/working-with-a-bucket.md)

0 commit comments

Comments
 (0)