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

docs: Fix typo in file name in "Create a pipeline" walkthrough #2255

Merged
merged 1 commit into from
Feb 2, 2025
+7 −7
Merged

docs: Fix typo in file name in "Create a pipeline" walkthrough #2255

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 7 additions & 7 deletions docs/website/docs/walkthroughs/create-a-pipeline.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,10 @@ def github_api_source(api_secret_key: str = dlt.secrets.value):
return github_api_resource(api_secret_key=api_secret_key)
```

Run the `github_api.py` pipeline script to test that authentication headers look fine:
Run the `github_api_pipeline.py` pipeline script to test that authentication headers look fine:

```sh
python github_api.py
python github_api_pipeline.py
```

Your API key should be printed out to stdout along with some test data.
Expand All @@ -87,7 +87,7 @@ Your API key should be printed out to stdout along with some test data.
We will use the `dlt` repository as an example GitHub project https://github.com/dlt-hub/dlt, feel free to replace it with your own repository.
:::

Modify `github_api_resource` in `github_api.py` to request issues data from your GitHub project's API:
Modify `github_api_resource` in `github_api_pipeline.py` to request issues data from your GitHub project's API:

```py
from dlt.sources.helpers.rest_client import paginate
Expand All @@ -109,8 +109,8 @@ def github_api_resource(api_secret_key: str = dlt.secrets.value):

## 4. Load the data

Uncomment the commented-out code in the `main` function in `github_api.py`, so that running the
`python github_api.py` command will now also run the pipeline:
Uncomment the commented-out code in the `main` function in `github_api_pipeline.py`, so that running the
`python github_api_pipeline.py` command will now also run the pipeline:

```py
if __name__=='__main__':
Expand All @@ -135,10 +135,10 @@ if __name__=='__main__':
```


Run the `github_api.py` pipeline script to test that the API call works:
Run the `github_api_pipeline.py` pipeline script to test that the API call works:

```sh
python github_api.py
python github_api_pipeline.py
```

This should print out JSON data containing the issues in the GitHub project.
Expand Down