Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

disable qdrant example test and fix snippet errors #1339

Merged
merged 2 commits into from
May 8, 2024
Merged

disable qdrant example test and fix snippet errors #1339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc2d90b
disable qdrant example test and fix snippet errors
sh-rp May 8, 2024
5c979b1
ignore secrets assignments
sh-rp May 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/tools/prepare_examples_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

# settings
SKIP_FOLDERS = ["archive", ".", "_", "local_cache"]
SKIP_EXAMPLES = ["qdrant_zendesk"]

# the entry point for the script
MAIN_CLAUSE = 'if __name__ == "__main__":'
Expand Down Expand Up @@ -40,6 +41,9 @@
if any(map(lambda skip: example.startswith(skip), SKIP_FOLDERS)):
continue

if example in SKIP_EXAMPLES:
continue

count += 1
example_file = f"{EXAMPLES_DIR}/{example}/{example}.py"
test_example_file = f"{EXAMPLES_DIR}/{example}/test_{example}.py"
Expand Down
2 changes: 1 addition & 1 deletion docs/website/docs/general-usage/http/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ from dlt.sources.helpers.rest_client.paginators import JSONResponsePaginator

github_client = RESTClient(
base_url="https://pokeapi.co/api/v2",
paginator=JSONResponsePaginator(next_url_path="next") # (1)
paginator=JSONResponsePaginator(next_url_path="next"), # (1)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch :)

data_selector="results", # (2)
)

Expand Down
12 changes: 6 additions & 6 deletions docs/website/docs/general-usage/http/rest-client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ from dlt.sources.helpers.rest_client.paginators import JSONResponsePaginator
client = RESTClient(
base_url="https://api.example.com",
headers={"User-Agent": "MyApp/1.0"},
auth=BearerTokenAuth(token="your_access_token_here"),
auth=BearerTokenAuth(token="your_access_token_here"), # type: ignore
paginator=JSONResponsePaginator(next_url_path="pagination.next"),
data_selector="data",
session=MyCustomSession()
Expand Down Expand Up @@ -191,7 +191,7 @@ E.g. `https://api.example.com/items?offset=0&limit=100`, `https://api.example.co

```json
{
"items": [...],
"items": ["one", "two", "three"],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to leave ellipsis?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it does not pass json parsing that way.. we can mark the block as text (which will disabled syntax highlighting) or write something like [{}, {}, {}].

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use the strings then

"total": 1000
}
```
Expand Down Expand Up @@ -223,7 +223,7 @@ Consider an API endpoint `https://api.example.com/data` returning a structure wh

```json
{
"items": [...],
"items": ["one", "two", "three"],
"cursors": {
"next": "cursor_string_for_next_page"
}
Expand Down Expand Up @@ -318,7 +318,7 @@ from dlt.sources.helpers.rest_client.auth import BearerTokenAuth

client = RESTClient(
base_url="https://api.example.com",
auth=BearerTokenAuth(token="your_access_token_here")
auth=BearerTokenAuth(token="your_access_token_here") # type: ignore
)

for page in client.paginate("/protected/resource"):
Expand All @@ -341,7 +341,7 @@ API Key Authentication (`ApiKeyAuth`) is an auth method where the client sends a
from dlt.sources.helpers.rest_client import RESTClient
from dlt.sources.helpers.rest_client.auth import APIKeyAuth

auth = APIKeyAuth(name="X-API-Key", api_key="your_api_key_here", location="header")
auth = APIKeyAuth(name="X-API-Key", api_key="your_api_key_here", location="header") # type: ignore

# Create a RESTClient instance with API Key Authentication
client = RESTClient(base_url="https://api.example.com", auth=auth)
Expand All @@ -364,7 +364,7 @@ HTTP Basic Authentication is a simple authentication scheme built into the HTTP
from dlt.sources.helpers.rest_client import RESTClient
from dlt.sources.helpers.rest_client.auth import HttpBasicAuth

auth = HttpBasicAuth(username="your_username", password="your_password")
auth = HttpBasicAuth(username="your_username", password="your_password") # type: ignore
client = RESTClient(base_url="https://api.example.com", auth=auth)

response = client.get("/protected/resource")
Expand Down
Loading