Skip to content

Move requirements-dev.txt dependencies to environment.yml #812

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.

Sign up for GitHub

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 11 commits into from
Feb 17, 2021
Merged

Move requirements-dev.txt dependencies to environment.yml #812

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
3a5fa7d
Fix the comments in requirements.txt and requirements-dev.txt
seisman Jan 28, 2021
0f63f1a
Merge branch 'master' into fix-requirements-comments
seisman Jan 29, 2021
b593ea3
Merge branch 'master' into fix-requirements-comments
seisman Jan 29, 2021
c75fc35
Merge branch 'master' into fix-requirements-comments
willschlitzer Feb 12, 2021
dfd2bda
Merge branch 'master' into fix-requirements-comments
weiji14 Feb 14, 2021
17613f2
Move dev dependency specification to environment.yml
weiji14 Feb 14, 2021
f822ab3
Use `conda env update` instead of `conda install`
weiji14 Feb 14, 2021
6958959
Let conda update the 'test' environment, not 'pygmt'
weiji14 Feb 15, 2021
ca703a3
Let setup miniconda auto activate pygmt conda environment
weiji14 Feb 15, 2021
4364312
Add section headers to environment.yml file
weiji14 Feb 17, 2021
94a91fe
Merge branch 'master' into fix-requirements-comments
weiji14 Feb 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 3 additions & 10 deletions .github/workflows/ci_tests.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,22 +69,15 @@ jobs:
- name: Setup Miniconda
uses: conda-incubator/[email protected]
with:
activate-environment: pygmt
python-version: ${{ matrix.python-version }}
channels: conda-forge
miniconda-version: "latest"

# Install GMT and other required dependencies from conda-forge
- name: Install GMT and required dependencies
- name: Install dependencies
shell: bash -l {0}
run: |
requirements_file=full-conda-requirements.txt
cat requirements.txt requirements-dev.txt > $requirements_file
cat << EOF >> $requirements_file
gmt=6.1.1
make
codecov
EOF
conda install --yes --file $requirements_file
run: conda env update --file environment.yml

# Show installed pkg information for postmortem diagnostic
- name: List installed packages
Expand Down
2 changes: 1 addition & 1 deletion MAINTENANCE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The main advantages of this are:

We use GitHub Actions continuous integration (CI) services to
build and test the project on Linux, macOS and Windows.
They rely on the `requirements.txt` file to install required dependencies using
They rely on the `environment.yml` file to install required dependencies using
conda and the `Makefile` to run the tests and checks.

### GitHub Actions
Expand Down
5 changes: 4 additions & 1 deletion environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,25 @@ channels:
- conda-forge
- defaults
dependencies:
- python=3.8
Copy link
Member Author

Choose a reason for hiding this comment

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

What about adding a few comment lines to group the dependencies into:

  1. required dependencies
  2. dev dependencies
  3. CI-specific dependencies (codecov, and make?)

Copy link
Member

Choose a reason for hiding this comment

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

Ok. But should we consider make a CI dependency, or a dev dependency? I feel as though make here might help on Windows, see #914 (comment).

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps just do required and dev dependencies (see the Suggested Changes I made below). codecov is a tiny 16.4kb wheel. make is 6.0MB on Windows but could be considered a dev dependency too.

Copy link
Member Author

Choose a reason for hiding this comment

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

Looks good.

# Required dependencies
- pip
- gmt=6.1.1
- numpy
- pandas
- xarray
- netCDF4
- packaging
# Development dependencies
- black
- blackdoc
- codecov
- coverage[toml]
- docformatter
- flake8
- ipython
- isort>=5
- jupyter
- make
- matplotlib
- nbsphinx
- pylint
Expand Down
19 changes: 0 additions & 19 deletions requirements-dev.txt
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Requirements for installing with conda
# Required packages
numpy
pandas
xarray
Expand Down