Skip to content

Use pip install as workaround when make install doesn't work #1585

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

Merged
merged 3 commits into from
Oct 20, 2021

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Oct 20, 2021

Description of proposed changes

Since a bugfix for pip=21.3 isn't out yet, this is a workaround inspired by zarr-developers/zarr-python@7ee2ded to fix the distutils error on Vercel builds:

  | distutils.errors.DistutilsError: Command '['/vercel/miniconda/envs/pygmt/bin/python3.9', '-m', 'pip', '--disable-pip-version-check', 'wheel', '--no-deps', '-w', '/tmp/tmp6lur8wxt', '--quiet', 'setuptools_scm']' returned non-zero exit status 1.

Also took the liberty to mention that make install is replaceable with pip install --no-deps -e . on Windows.

Fixes #1575 (comment) and #1471 (comment).

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

Fixes issue with `pip=21.3`, inspired by commit from
zarr-developers/zarr-python@7ee2ded.
So that Windows users without `make`
can install an editable version of PyGMT locally.
@weiji14 weiji14 added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Oct 20, 2021
@weiji14 weiji14 added this to the 0.5.0 milestone Oct 20, 2021
@weiji14 weiji14 self-assigned this Oct 20, 2021
@weiji14 weiji14 marked this pull request as ready for review October 20, 2021 02:52
@maxrjones
Copy link
Member

Is your plan to revert back to make install after a bug fix comes out or keep this long-term?

@weiji14
Copy link
Member Author

weiji14 commented Oct 20, 2021

Is your plan to revert back to make install after a bug fix comes out or keep this long-term?

I think keep this long term, since editable installs don't make sense on the cloud anyway.

@weiji14 weiji14 merged commit eaf2c10 into main Oct 20, 2021
@weiji14 weiji14 deleted the pip-e-install branch October 20, 2021 21:21
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…MappingTools#1585)

* Don't use editable install for vercel build

Fixes issue with `pip=21.3`, inspired by commit from
zarr-developers/zarr-python@7ee2ded.

* Mention how Windows users can install PyGMT in editable mode

So that Windows users without `make`
can install an editable version of PyGMT locally.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants