innolitics/rdm

Encountering error using Quick Start instructions

Closed this issue · 2 comments

dheater commented

When I just run the Quick Start instructions from the README, I get the following error:

rdm pull config.yml > data/history.yml
Traceback (most recent call last):
  File "/home/dheater/src/rdm-test1/venv/lib/python3.8/site-packages/rdm/main.py", line 21, in main
    exit_code = cli(sys.argv[1:])
  File "/home/dheater/src/rdm-test1/venv/lib/python3.8/site-packages/rdm/main.py", line 43, in cli
    pull_from_project_manager(args.config)
  File "/home/dheater/src/rdm-test1/venv/lib/python3.8/site-packages/rdm/pull.py", line 14, in pull_from_project_manager
    BackendClass = load_class(config['project_management_backend'])
  File "/home/dheater/src/rdm-test1/venv/lib/python3.8/site-packages/rdm/util.py", line 123, in load_class
    module = import_module(module_name)
  File "/usr/lib/python3.8/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
  File "<frozen importlib._bootstrap>", line 991, in _find_and_load
  File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 783, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/home/dheater/src/rdm-test1/venv/lib/python3.8/site-packages/rdm/project_management/__init__.py", line 2, in <module>
    from .github import GitHubIssueBackend, GitHubPullRequestBackend
  File "/home/dheater/src/rdm-test1/venv/lib/python3.8/site-packages/rdm/project_management/github.py", line 6, in <module>
    from github import Github
ModuleNotFoundError: No module named 'github'

Either the Quick Start instructions should use pip install rdm[svg,github] to pull in Github support or maybe the default config.yml shouldn't assume the GithubIssueBackend (if that's possible?)

johndgiese commented

It would be possible to update the default config.yml so that it doesn't use the GithubIssueBackend.

I can see arguments for and against doing this.

Arguments for:

  • The default setup will keep the number of third party packages to a minimum (in particular, the default won't use pygithub)

Arguments against:

  • GitHub is very popular, especially with open source projects, so it may be nice to have GitHub work well by default. Also, our current templates have a few places with GitHub hardcoded into them. (We will eventually change this though.)

I tend to think, for now, that updating the Quick Start instructions to use pip install rdm[svg,github] makes sense. @dheater what do you think?

dheater commented

I'm good with that

  • 👍1