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

Correctly simplify the installation process. #13

Merged
merged 1 commit into from
Feb 28, 2019

Conversation

metatoaster
Copy link
Member

Don't override the cmdclass for something that can be solved trivially with an additional line in requirements.txt. Also document the command and specify the dependencies inside the setup function so that they will persist into the wheel.

@metatoaster
Copy link
Member Author

Of course, if the packages are not on pypi (yet) the install command can be used, since downstream users won't see the requirements.txt, and if they (i.e. scaffoldmaker-web-demo) try to install it they will also need the contents there, but at least with this the missing dependencies will be flagged.

For instance

$ pip install -r requirements.txt
...
Obtaining scaffoldmaker from git+https://github.com/metatoaster/scaffoldmaker.git#egg=scaffoldmaker (from -r requirements.txt (line 1))
  git clone in ./.env35/src/scaffoldmaker exists with URL https://github.com/ABI-Software/scaffoldmaker.git
...
Collecting opencmiss.utils (from scaffoldmaker->-r requirements.txt (line 1))
  Could not find a version that satisfies the requirement opencmiss.utils (from scaffoldmaker->-r requirements.txt (line 1)) (from versions: )
No matching distribution found for opencmiss.utils (from scaffoldmaker->-r requirements.txt (line 1))

# minimal requirements listing
'opencmiss.utils',
'ZincPythonTools',
]
Copy link
Member

@alan-wu alan-wu Feb 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can also use the following instead

['opencmiss.utils @ https://api.github.com/repos/OpenCMISS-Bindings/opencmiss.utils/tarball/master', 
'ZincPythonTools @  https://api.github.com/repos/OpenCMISS-Bindings/ZincPythonTools/tarball/master']

This should work for downstream users such as scaffold-web-demo.

@alan-wu
Copy link
Member

alan-wu commented Feb 28, 2019

I think this change should be accepted and I will be making some more changes as there are missing required packages such as numpy and scipy.

@alan-wu alan-wu merged commit 78222df into ABI-Software:master Feb 28, 2019
@metatoaster
Copy link
Member Author

Oh, now that you got this merged in with this modification, the requirements.txt can be removed and the installation instructions should be updated to pip install -e . in the README to further reduce typing.

@alan-wu
Copy link
Member

alan-wu commented Feb 28, 2019

Oh, now that you got this merged in with this modification, the requirements.txt can be removed and the installation instructions should be updated to pip install -e . in the README to further reduce typing.

Sure, I will update that now.

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