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
+14-6Lines changed: 14 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,21 @@
4
4
5
5
The Glean Python SDK provides convenient access to the Glean REST API from any Python 3.8+ application. It includes type hints for all request parameters and response fields, and supports both synchronous and asynchronous usage via [httpx](https://www.python-httpx.org/).
6
6
7
+
<!-- Start Summary [summary] -->
8
+
## Summary
9
+
10
+
Glean API: # Introduction
11
+
In addition to the data sources that Glean has built-in support for, Glean also provides a REST API that enables customers to put arbitrary content in the search index. This is useful, for example, for doing permissions-aware search over content in internal tools that reside on-prem as well as for searching over applications that Glean does not currently support first class. In addition these APIs allow the customer to push organization data (people info, organization structure etc) into Glean.
12
+
13
+
# Usage guidelines
14
+
This API is evolving fast. Glean will provide advance notice of any planned backwards incompatible changes along
15
+
with a 6-month sunset period for anything that requires developers to adopt the new versions.
16
+
<!-- End Summary [summary] -->
17
+
7
18
<!-- Start Table of Contents [toc] -->
8
19
## Table of Contents
9
20
<!-- $toc-max-depth=2 -->
21
+
*[Glean Python API Client](#glean-python-api-client)
10
22
*[Usage guidelines](#usage-guidelines)
11
23
*[SDK Installation](#sdk-installation)
12
24
*[IDE Support](#ide-support)
@@ -29,10 +41,6 @@ The Glean Python SDK provides convenient access to the Glean REST API from any P
29
41
<!-- Start SDK Installation [installation] -->
30
42
## SDK Installation
31
43
32
-
> [!TIP]
33
-
> To finish publishing your SDK to PyPI you must [run your first generation action](https://www.speakeasy.com/docs/github-setup#step-by-step-guide).
34
-
35
-
36
44
> [!NOTE]
37
45
> **Python version upgrade policy**
38
46
>
@@ -45,15 +53,15 @@ The SDK can be installed with either *pip* or *poetry* package managers.
45
53
*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.
*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.
0 commit comments