Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing dependency to installation instructions #248

Merged
merged 1 commit into from
Oct 11, 2020

Conversation

vollkorn1982
Copy link

The instructions in INSTALL.md are missing argcomplete as it is listed in the requirements.txt.

Description

I added the missing argcomplete in INSTALL.md.

If argcomplete is not installed on your system, starting gourmet results in an error:

$ gourmet 
Traceback (most recent call last):
  File "/home/jan/.local/bin/gourmet", line 5, in <module>
    from gourmet.GourmetRecipeManager import launch_app
  File "/home/jan/.local/lib/python3.8/site-packages/gourmet/GourmetRecipeManager.py", line 11, in <module>
    from gourmet import (
  File "/home/jan/.local/lib/python3.8/site-packages/gourmet/batchEditor.py", line 3, in <module>
    from . import gglobals
  File "/home/jan/.local/lib/python3.8/site-packages/gourmet/gglobals.py", line 8, in <module>
    from .optionparser import args
  File "/home/jan/.local/lib/python3.8/site-packages/gourmet/optionparser.py", line 2, in <module>
    import argcomplete
ModuleNotFoundError: No module named 'argcomplete'

How Has This Been Tested?

I tried installing gourmet on a fresh Ubuntu 20.04 installation and ran into the error message above. Then I installed the missing dependency by running python3 -m pip install argcomplete and tried running gourmet again. This time gourmet started without a problem.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@cydanil
Copy link
Collaborator

cydanil commented Oct 11, 2020

Fantastic! Thanks a lot for taking the time to fix the docs :)

@cydanil cydanil merged commit 67e9d40 into kirienko:master Oct 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants