Generalize GitHub URI to allow GitHub Enterprise host

[lgonzalezsa]

Was trying to use nbdev_release_gh and was having fastcore.basics.HTTP401UnauthorizedError: HTTP Error 401: Unauthorized
Reviewing the code in https://github.com/fastai/nbdev/blob/master/nbs/17_release.ipynb
Specifically the cell:

#| export
GH_HOST = "https://api.github.com" 

Could be possible to include a parameter en settings.ini with the URI to use?
I have the option to run nbdev in our GitHub Enterprise then the GH_HOST is different.

PD: what could be the best way to reference a specific code line if using Jupyter Notebook? referencing the specific JSON line?

[seeM]

@lgonzalezsa Could you please try setting the GH_HOST environment variable before running nbdev_release_gh?

nbdev.release uses ghapi which uses that environment variable over here: https://github.com/fastai/ghapi/blob/d86f41815418384ed3cf32a8526c4843d060ce7b/ghapi/core.py#L20

I tend to link to the corresponding .py file when possible. Unfortunately GitHub isn't yet very good at linking to and rendering notebooks. I use the "Copy permalink" feature so that the link always works - rather than linking to a branch with code that's likely to change.

[lgonzalezsa]

Based on GitHub documentation the API schema changes a bit and not sure if differs with public REST API.
nbdev defines:
GH_HOST = "https://api.github.com"

According to GitHub documentation able to test a call with my token, then exported as follow:
GH_HOST = "http(s)://[hostname]/api/v3"
Resulting on:
pickle.PicklingError: Can't pickle <class 'fastcore.basics.HTTP404NotFoundError'>: attribute lookup HTTP404NotFoundError on fastcore.basics failed

[seeM]

I’m sorry, I don’t follow. Have you tried setting the environment variable I mentioned above? For example:

GH_HOST=<your enterprise url here> nbdev_release_gh

[seeM]

Oh, did that cause the pickling error?

[lgonzalezsa]

Correct, sorry, was testing exporting the GH_HOST variable following GitHub documentation and that cause the pickling issue.
I did test the endpoint with my token and works, then seems the URI I use is correct, what I am not sure if the API varies from GitHub public to the GitHub Enterprise.

[seeM]

I see! Jeremy recently added the ability in ghapi to set the env var GITHUB_DEBUG=1 to print request info. That might help determine whether the api schema differs

[lgonzalezsa]

Testing it but seems same output to me.

[seeM]

Do you have the latest ghapi installed?

[lgonzalezsa]

Updating from 1.0.0 to 1.0.1 same traceback output.

(conda_dev) gonluisr@gonluisr-hp-zbook-15-g3:~/Downloads/scripts$ conda list | grep ghapi
ghapi                     1.0.1                      py_0    fastai

Testing ghapi directly seems to work:

ghapi git.get_ref luis-gs linux-setup --ref heads/master
{'ref': 'refs/heads/master', 'node_id': 'MDM6UmVmMTk0MDcxOnJlZnMvaGVhZHMvbWFzdGVy', 'url': 'https://github.enterprise.com/api/v3/repos/luis-gs/linux-setup/git/refs/heads/master', 'object': {'sha': '8d4e3d3fe5b6ab17191eefbdf85664ab1f4377c1', 'type': 'commit', 'url': 'https://github.enterprise.com/api/v3/repos/luis-gs/linux-setup/git/commits/8d4e3d3fe5b6ab17191eefbdf85664ab1f4377c1'}}

[seeM]

I think this is a minimal example btw. Hard for me to reproduce because I don't have GH enterprise to test with.

from ghapi.core import GhApi
gh = GhApi('luis-gs', 'linux-setup')
gh.issues.list_for_repo(state='closed', sort='created', filter='all', since='2000-01-01T00:00:004Z', labels='enhancement')

[lgonzalezsa]

I understand, thank you for your help, here the traceback:

Unexpected exception formatting exception. Falling back to standard exception
Traceback (most recent call last):
  File "/home/gonluisr/miniconda3/envs/conda_dev/lib/python3.9/site-packages/IPython/core/interactiveshell.py", line 3398, in run_code
    exec(code_obj, self.user_global_ns, self.user_ns)
  File "/tmp/ipykernel_281120/3649172761.py", line 1, in <cell line: 1>
    gh.issues.list_for_repo(state='closed', sort='created', filter='all', since='2000-01-01T00:00:004Z', labels='enhancement')
  File "/home/gonluisr/miniconda3/envs/conda_dev/lib/python3.9/site-packages/ghapi/core.py", line 61, in __call__
    return self.client(self.path, self.verb, headers=headers, route=route_p, query=query_p, data=data_p)
  File "/home/gonluisr/miniconda3/envs/conda_dev/lib/python3.9/site-packages/ghapi/core.py", line 118, in __call__
    res,self.recv_hdrs = urlsend(path, verb, headers=headers or None, debug=debug, return_headers=True,
  File "/home/gonluisr/miniconda3/envs/conda_dev/lib/python3.9/site-packages/fastcore/net.py", line 214, in urlsend
    return urlread(req, return_json=return_json, return_headers=return_headers)
  File "/home/gonluisr/miniconda3/envs/conda_dev/lib/python3.9/site-packages/fastcore/net.py", line 115, in urlread
    if 400 <= e.code < 500: raise ExceptionsHTTP[e.code](e.url, e.hdrs, e.fp) from None
fastcore.basics.HTTP404NotFoundError: HTTP Error 404: Not Found

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/gonluisr/miniconda3/envs/conda_dev/lib/python3.9/site-packages/IPython/core/interactiveshell.py", line 1990, in showtraceback
    if hasattr(value, "_render_traceback_"):
  File "/home/gonluisr/miniconda3/envs/conda_dev/lib/python3.9/tempfile.py", line 472, in __getattr__
    file = self.__dict__['file']
KeyError: 'file'

[seeM]

Okay so it does seem to be a path issue. If you could get an example working for the issues/list_for_repos endpoint with enterprise, even if it uses curl, that might be a good start