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

CONTRIBUTING.md install instructions are wrong (add dev-environment.yml?) #229

Closed
erikmannerfelt opened this issue Jul 9, 2021 · 0 comments · Fixed by #248
Closed

CONTRIBUTING.md install instructions are wrong (add dev-environment.yml?) #229

erikmannerfelt opened this issue Jul 9, 2021 · 0 comments · Fixed by #248
Labels
enhancement Feature improvement or request invalid This doesn't seem right test-suite

Comments

@erikmannerfelt
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The current installation approach in CONTRIBUTING.md does not work.

It says to run:

git clone https://github.com/GlacioHack/geoutils.git
cd geoutils
conda create -f environment.yml  # add '-n custom_name' if you want.
conda activate geoutils  # or any other name specified above
pip install -e .

Then "pytest can be run":

pytest

This is false, as not even pytest is installed with the environment.yml!

Packages that are missing

  • pytest
  • pytest-xdist (kind of optional)
  • sphinx
  • numpydoc
  • sphinx_rtd_theme
  • sphinx-autodoc-typehints
  • sphinxcontrib-programoutput
  • flake8
  • matplotlib
  • pre-commit

Describe the solution you'd like
Add a dev-environment.yml with the aforementioned and base packages.

Describe alternatives you've considered
An alternative is to expand environment.yml, but this would install lots of unnecessary stuff for users that clone the latest main. A question, however, is how many users will clone the latest main? One? Two? Perhaps it's okay to just have one environment file! Dependencies are already defined in four places, so one more would be quite annoying:

  • environment.yml
  • setup.py
  • dev-requirements.txt
  • meta.yaml

My preferred fix

Add the development dependencies to environment.yml!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Feature improvement or request invalid This doesn't seem right test-suite
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant