search

riverrun / genxword

Crossword generator written in Python.
GNU General Public License v3.0
162 stars 40 forks source link

Add dependency info to setup.py #17

Closed cslycord closed 4 years ago

cslycord commented 4 years ago

Added install_requires information into setuptools section so that the package can track dependencies properly.

riverrun commented 4 years ago

Thanks for the help.

By the way, what will happen if the dependencies, outlined by 'install_requires' are not present? Will it just present a warning to the user?

cslycord commented 4 years ago

If you're using pip for installation and don't manually install pycairo and PyGObject, then genxword installs fine, but crashes when run.

genxword displays ModuleNotFoundError: No module named 'gi'

There's no warning at installation, because pip didn't know what to warn you about. And there's no warning upon it being run, because the script imports without checking.

On Wed, Sep 25, 2019, 12:26 PM David Whitlock notifications@github.com wrote:

Thanks for the help.

By the way, what will happen if the dependencies, outlined by 'install_requires' are not present? Will it just present a warning to the user?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/riverrun/genxword/pull/17?email_source=notifications&email_token=AC5TL7PO52NWDXE25E6IZ7DQLLK47A5CNFSM4IX6JNIKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD7QO4MQ#issuecomment-534834738, or mute the thread https://github.com/notifications/unsubscribe-auth/AC5TL7JL3VUJEYEBWGVWYBDQLLK47ANCNFSM4IX6JNIA .

riverrun commented 4 years ago

Ok. So does 'install_requires' work as a form of documentation then (telling the user what is needed)?

cslycord commented 4 years ago

No. It's for making the package itself aware of its own dependencies so that running "pip install genxword" automatically installs the packages mentioned in install_requires.

On Wed, Sep 25, 2019, 3:11 PM David Whitlock notifications@github.com wrote:

Ok. So does 'install_requires' work as a form of documentation then (telling the user what is needed)?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/riverrun/genxword/pull/17?email_source=notifications&email_token=AC5TL7MVWQD4YMFYS4D3463QLL6IPA5CNFSM4IX6JNIKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD7QXN4A#issuecomment-534869744, or mute the thread https://github.com/notifications/unsubscribe-auth/AC5TL7OGNWZ6GIEA5S2ANBDQLL6IPANCNFSM4IX6JNIA .