Skip to content

Commit

Permalink
Docs: fix pipeline file name (#2255)
Browse files Browse the repository at this point in the history
  • Loading branch information
lpillmann authored Feb 2, 2025
1 parent 9ea3812 commit e5e7a8c
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/website/docs/walkthroughs/create-a-pipeline.md
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

0 comments on commit e5e7a8c

Please sign in to comment.