You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-10Lines changed: 5 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,6 @@ with a 6-month sunset period for anything that requires developers to adopt the
38
38
39
39
<!-- End Table of Contents [toc] -->
40
40
41
-
<!-- Start SDK Installation [installation] -->
42
41
## SDK Installation
43
42
44
43
> [!NOTE]
@@ -53,23 +52,23 @@ The SDK can be installed with either *pip* or *poetry* package managers.
53
52
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
54
53
55
54
```bash
56
-
pip install glean
55
+
pip install api-client-glean
57
56
```
58
57
59
58
### Poetry
60
59
61
60
*Poetry* is a modern tool that simplifies dependency management and package publishing by using a single `pyproject.toml` file to handle project metadata and dependencies.
62
61
63
62
```bash
64
-
poetry add glean
63
+
poetry add api-client-glean
65
64
```
66
65
67
66
### Shell and script usage with `uv`
68
67
69
68
You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:
70
69
71
70
```shell
72
-
uvx --from glean python
71
+
uvx --from api-client-glean python
73
72
```
74
73
75
74
It's also possible to write a standalone Python script without needing to set up a whole project like so:
@@ -79,7 +78,7 @@ It's also possible to write a standalone Python script without needing to set up
79
78
# /// script
80
79
# requires-python = ">=3.9"
81
80
# dependencies = [
82
-
# "glean",
81
+
# "api-client-glean",
83
82
# ]
84
83
# ///
85
84
@@ -94,7 +93,7 @@ sdk = Glean(
94
93
95
94
Once that is saved to a file, you can run it with `uv run script.py` where
96
95
`script.py` can be replaced with the actual file name.
|`x_scio_actas`|*Optional[str]*|:heavy_minus_sign:| Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens). |
8
+
|`x_glean_act_as`|*Optional[str]*|:heavy_minus_sign:| Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens). |
9
9
|`x_glean_auth_type`|*Optional[str]*|:heavy_minus_sign:| Auth type being used to access the endpoint (should be non-empty only for global tokens). |
10
10
|`add_collection_items_request`|[models.AddCollectionItemsRequest](../models/addcollectionitemsrequest.md)|:heavy_check_mark:| Data describing the add operation. |
0 commit comments