jupyterhub / nbgitpuller

Jupyter server extension to sync a git repository one-way to a local path
https://nbgitpuller.readthedocs.io
BSD 3-Clause "New" or "Revised" License
205 stars 84 forks source link

add command line debug option #304

Open WolfgangFahl opened 1 year ago

WolfgangFahl commented 1 year ago

Proposed change

supply a command line tool that may be used in a docker image for checking proper operation

Alternative options

Who would use this feature?

Anybody who has to debug a non working nbgitpuller environment

(Optional): Suggest a solution

Change the pyproject.toml file and add a script. use argparser or click and allow using functionality this way.

welcome[bot] commented 1 year ago

Thank you for opening your first issue in this project! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out Jupyter's Code of Conduct. Also, please try to follow the issue template as it helps other other community members to contribute more effectively. welcome You can meet the other Jovyans by joining our Discourse forum. There is also an intro thread there where you can stop by and say Hi! :wave:
Welcome to the Jupyter community! :tada:

yuvipanda commented 1 year ago

There is one! https://github.com/jupyterhub/nbgitpuller/blob/8827509f728a138b174c61165ebdcc1b0430a136/nbgitpuller/pull.py#L347 although it looks like it isn't documented well?

WolfgangFahl commented 1 year ago

So it might be more a matter of installing a command line access to the python modules offering such services see : https://stackoverflow.com/a/75419857/1497139

WolfgangFahl commented 1 year ago

Oh i see what the problem is - the project does not use pyproject.toml yet but still has a setup.py - i didn't expect that and didn't even look for it - so the command is gitpuller.

After install things with

pip install . --user
gitpuller -h
usage: gitpuller [-h] git_url [branch_name] [repo_dir]

Synchronizes a github repository with a local repository.

positional arguments:
  git_url      Url of the repo to sync
  branch_name  Branch of repo to sync
  repo_dir     Path to clone repo under

options:
  -h, --help   show this help message and exit

is available

WolfgangFahl commented 1 year ago

Unfortunately there is no debug, no verbose and no version option. Having a link to the source code is helpful though.

WolfgangFahl commented 1 year ago

I still can't find out why nbgitpuller isn't working properly in our environment. Is there a log file somewhere by default?