Download release assets

[nicola-lunghi]

The documentation says that I can download a release assets with:

• https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28#get-a-release-asset

To download the asset's binary content, set the Accept header of the request to [application/octet-stream](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

Can I do it with this library?

[xvega]

The documentation says that I can download a release assets with:

• https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28#get-a-release-asset

To download the asset's binary content, set the Accept header of the request to [application/octet-stream](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

Can I do it with this library?

I don't think this library provides a direct method to download assets, but you could use the asset's URL with a HTTP library like requests to download the asset.

PyGithub/github/GitReleaseAsset.py

Line 126 in 0b8435f

def browser_download_url(self) -> str:

This is an idea/pseudocode that might help you get started (haven't tested this)

from github import Github
import requests

g = Github("your token")
repo = g.get_repo("your repo")

# Get the specific release or terate over releases
release = repo.get_release("tag_name")

# Loop through assets in the release
for asset in release.get_assets():
    response = requests.get(asset.browser_download_url, allow_redirects=True)
    # whatever you need to do with the binary 

[nicola-lunghi]

yes it's also missing a way to download workflow artifacts

…

On Tue, 12 Mar 2024, 19:27 Xavi Vega, ***@***.***> wrote: The documentation says that I can download a release assets with: - https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28#get-a-release-asset To download the asset's binary content, set the Accept header of the request to [application/octet-stream](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response. Can I do it with this library? I don't think this library provides a direct method to download assets, but you could use the asset's URL with a HTTP library like requests to download the asset. https://github.com/PyGithub/PyGithub/blob/0b8435fccbcc98404f08e146b6e259bd20065c98/github/GitReleaseAsset.py#L126 This is an idea/pseudocode that might help you get started (haven't tested this) from github import Githubimport requests g = Github("your token")repo = g.get_repo("your repo") # Get the specific release or terate over releasesrelease = repo.get_release("tag_name") # Loop through assets in the releasefor asset in release.get_assets(): response = requests.get(asset.browser_download_url, allow_redirects=True) # whatever you need to do with the binary — Reply to this email directly, view it on GitHub <#2918 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AGB6YTALMGEPNFFP4DS7MW3YX5JJHAVCNFSM6AAAAABESEDECOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJSGM4DGOJSG4> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[nicola-lunghi]

i solved with something similar but was wondering if could be added

…

On Tue, 12 Mar 2024, 19:28 nick83ola, ***@***.***> wrote: yes it's also missing a way to download workflow artifacts On Tue, 12 Mar 2024, 19:27 Xavi Vega, ***@***.***> wrote: > The documentation says that I can download a release assets with: > > - > https://docs.github.com/en/rest/releases/assets?apiVersion=2022-11-28#get-a-release-asset > > To download the asset's binary content, set the Accept header of the request to [application/octet-stream](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response. > > Can I do it with this library? > > I don't think this library provides a direct method to download assets, > but you could use the asset's URL with a HTTP library like requests to > download the asset. > > > https://github.com/PyGithub/PyGithub/blob/0b8435fccbcc98404f08e146b6e259bd20065c98/github/GitReleaseAsset.py#L126 > > This is an idea/pseudocode that might help you get started (haven't > tested this) > > from github import Githubimport requests > g = Github("your token")repo = g.get_repo("your repo") > # Get the specific release or terate over releasesrelease = repo.get_release("tag_name") > # Loop through assets in the releasefor asset in release.get_assets(): > response = requests.get(asset.browser_download_url, allow_redirects=True) > # whatever you need to do with the binary > > — > Reply to this email directly, view it on GitHub > <#2918 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/AGB6YTALMGEPNFFP4DS7MW3YX5JJHAVCNFSM6AAAAABESEDECOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJSGM4DGOJSG4> > . > You are receiving this because you authored the thread.Message ID: > ***@***.***> >

[nicola-lunghi]

Hi @EnricoMi if I submit a PR would you accept this? there's a good reason why this is not included? there's a similar API also for downloading job artifacts.
Also where I can add this functionality?

    request_url = f"{__gh_base_url__}/repos/{artifact_data['repo_name']}/releases/assets/{artifact_data['id']}"
    headers = {
        "Accept": "application/octet-stream",
        "Authorization": f"Bearer {token}",
    }

    with open(destfile, "wb") as f:
        r = requests.get(request_url, headers=headers, stream=True, timeout=5)
        total_length = r.headers.get("content-length")

        if total_length is None:  # no content length header
            f.write(r.content)
        else:
            for chunk in r.iter_content(chunk_size=4096):
                f.write(chunk)

the missing functionality is to be able to set this header

      "Accept": "application/octet-stream",