Skip to content

Commit

Permalink
Document minimum supported dependency versions
Browse files Browse the repository at this point in the history
  • Loading branch information
adamjstewart committed Aug 11, 2021
1 parent 0b1266e commit d9d8699
Show file tree
Hide file tree
Showing 8 changed files with 113 additions and 81 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/style.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
with:
python-version: 3.9
- name: Install black
run: pip install --pre 'black[colorama]>=21'
run: pip install --pre 'black>=21'
- name: Run black checks
run: black . --check --diff
flake8:
Expand All @@ -42,7 +42,7 @@ jobs:
with:
python-version: 3.9
- name: Install flake8
run: pip install flake8
run: pip install 'flake8>=3.8'
- name: Run flake8 checks
run: flake8
isort:
Expand All @@ -56,6 +56,6 @@ jobs:
with:
python-version: 3.9
- name: Install isort
run: pip install 'isort[colors]>=4.3.5'
run: pip install 'isort[colors]>=5.8'
- name: Run isort checks
run: isort . --check --diff
7 changes: 5 additions & 2 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,10 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python-version: [3.7, 3.8, 3.9]
python-version: [3.6, 3.7, 3.8, 3.9]
exclude:
- os: windows-latest
python-version: 3.6
steps:
- name: Clone repo
uses: actions/checkout@v2
Expand All @@ -62,7 +65,7 @@ jobs:
if: ${{ runner.os == 'Windows' }}
- name: Install conda dependencies (Windows)
run: |
conda install fiona h5py 'rasterio>=1.0'
conda install 'fiona>=1.5' h5py 'rasterio>=1.0.16'
conda list
conda info
if: ${{ runner.os == 'Windows' }}
Expand Down
4 changes: 4 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build"]

# Sphinx 3.0+ required for:
# autodoc_typehints = "description"
needs_sphinx = "3.0"

nitpicky = True
nitpick_ignore = [
# https://github.com/sphinx-doc/sphinx/issues/8127
Expand Down
34 changes: 17 additions & 17 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,34 @@ channels:
- conda-forge
dependencies:
- cudatoolkit
- fiona
- fiona>=1.5
- h5py
- numpy
- pip
- pycocotools
- python
- python>=3.6
- pytorch-gpu>=1.7
- rarfile
- rasterio>=1.0
- rarfile>=3
- rasterio>=1.0.16
- torchvision>=0.3
- pip:
- black[colorama]>=21b
- flake8
- isort[colors]>=4.3.5
- black>=21.4b0
- flake8>=3.8
- isort[colors]>=5.8
- jupyterlab
- mypy>=0.900
- omegaconf
- omegaconf>=2.1
- opencv-python
- pillow
- pillow>=2.9
- pydocstyle[toml]>=6.1
- pytest>=6.0
- pytest-cov
- pytorch-lightning
- pytest>=6
- pytest-cov>=2.4
- pytorch-lightning>=1.3
- git+https://github.com/pytorch/pytorch_sphinx_theme
- radiant-mlhub>=0.2.1
- rtree>=0.5.0
- scikit-learn
- segmentation-models-pytorch
- setuptools>=42
- sphinx
- rtree>=0.5
- scikit-learn>=0.18
- segmentation-models-pytorch>=0.2
- setuptools>=30.4
- sphinx>=3
- torchmetrics
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ requires = [
build-backend = "setuptools.build_meta"

[tool.black]
target-version = ["py37", "py38", "py39"]
target-version = ["py36", "py37", "py38", "py39"]
color = true
exclude = '''
/(
Expand Down
56 changes: 40 additions & 16 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,29 +1,53 @@
black[colorama]>=21b
fiona
flake8
# black 21+ required for Python 3.9 support
black>=21
# fiona 1.5+ required for fiona.transform module
fiona>=1.5
# flake8 3.8+ depends on pyflakes 2.2+, which fixes a bug with mypy error code ignores:
# https://github.com/PyCQA/pyflakes/pull/455
flake8>=3.8
h5py
isort[colors]>=4.3.5
# isort 5.8+ required for extend_skip option
isort[colors]>=5.8
jupyterlab
matplotlib
# mypy 0.900+ required for pyproject.toml support
mypy>=0.900
numpy
omegaconf
# omegaconf 2.1+ required for to_object method
omegaconf>=2.1
opencv-python
pillow
# pillow 2.9+ required for height attribute
pillow>=2.9
pycocotools
# pydocstyle 6.1+ required for pyproject.toml support
pydocstyle[toml]>=6.1
pytest>=6.0
pytest-cov
pytorch-lightning
# pytest 6+ required for pyproject.toml support
pytest>=6
# pytest-cov 2.4+ required for pytest --cov flags
pytest-cov>=2.4
# pytorch-lightning 1.3+ required for gradient_clip_algorithm argument to Trainer
pytorch-lightning>=1.3
# release versions missing files, must install from master
git+https://github.com/pytorch/pytorch_sphinx_theme
# radiant-mlhub 0.2.1+ required for api_key bugfix:
# https://github.com/radiantearth/radiant-mlhub/pull/48
radiant-mlhub>=0.2.1
rarfile
rasterio>=1.0
rtree>=0.5.0
scikit-learn
segmentation-models-pytorch
setuptools>=42
sphinx
# rarfile 3+ required for correct Rar file detection
rarfile>=3
# rasterio 1.0.16+ required for CRS support
rasterio>=1.0.16
# rtree 0.5+ required for 3D index support
rtree>=0.5
# scikit-learn 0.18+ required for sklearn.model_selection module
scikit-learn>=0.18
# segmentation-models-pytorch 0.2+ required for smp.losses module
segmentation-models-pytorch>=0.2
# setuptools 30.4+ required for options.packages.find section in setup.cfg
setuptools>=30.4
# sphinx 3+ required for autodoc_typehints = description
sphinx>=3
# torch 1.7+ required for typing
torch>=1.7
torchmetrics
# torchvision 0.3+ required for download_file_from_google_drive
torchvision>=0.3
35 changes: 18 additions & 17 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ classifiers =
Development Status :: 1 - Planning
Intended Audience :: Science/Research
Programming Language :: Python :: 3
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Programming Language :: Python :: 3.9
Expand All @@ -23,17 +24,17 @@ keywords = pytorch, deep learning, machine learning

[options]
setup_requires =
setuptools>=42
setuptools>=30.4
install_requires =
fiona
fiona>=1.5
matplotlib
numpy
pillow
rasterio>=1.0
rtree>=0.5.0
pillow>=2.9
rasterio>=1.0.16
rtree>=0.5
torch>=1.7
torchvision>=0.3
python_requires = >= 3.7
python_requires = >= 3.6
packages = find:

[options.packages.find]
Expand All @@ -46,25 +47,25 @@ datasets =
opencv-python
pycocotools
radiant-mlhub>=0.2.1
rarfile
rarfile>=3

# Optional developer requirements
docs =
jupyterlab
sphinx
sphinx>=3
pydocstyle[toml]>=6.1
pytorch-sphinx-theme
style =
black[colorama]>=21
flake8
isort[colors]>=4.3.5
black>=21
flake8>=3.8
isort[colors]>=5.8
tests =
mypy>=0.900
pytest>=6.0
pytest-cov
pytest>=6
pytest-cov>=2.4
train =
omegaconf
pytorch-lightning
scikit-learn
segmentation-models-pytorch
omegaconf>=2.1
pytorch-lightning>=1.3
scikit-learn>=0.18
segmentation-models-pytorch>=0.2
torchmetrics
50 changes: 25 additions & 25 deletions spack.yaml
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
spack:
specs:
- opencv+python3+imgcodecs+tiff+jpeg+png
- pil
- "python@3.7:+bz2"
- "py-black@21:+colorama"
- py-fiona
- py-flake8
- py-h5py
- "py-isort@4.3.5:+colors"
- py-jupyterlab
- py-matplotlib
- "opencv+python3+imgcodecs+tiff+jpeg+png"
- "pil@2.9:"
- "python@3.6:+bz2"
- "py-black@21:"
- "py-fiona@1.5:"
- "py-flake8@3.8:"
- "py-h5py"
- "py-isort@5.8:+colors"
- "py-jupyterlab"
- "py-matplotlib"
- "[email protected]:"
- py-numpy
- py-omegaconf
- py-pycocotools
- "py-numpy"
- "py-omegaconf@2.1:"
- "py-pycocotools"
- "[email protected]:+toml"
- "py-pytest@6.0:"
- py-pytest-cov
- py-pytorch-lightning
- py-pytorch-sphinx-theme
- "py-pytest@6:"
- "py-pytest-cov@2.4:"
- "py-pytorch-lightning@1.3:"
- "py-pytorch-sphinx-theme"
- "[email protected]:"
- py-rarfile
- "[email protected]:"
- "[email protected].0:"
- py-scikit-learn
- py-segmentation-models-pytorch
- "py-setuptools@42:"
- py-sphinx
- "py-rarfile@3:"
- "[email protected].16:"
- "[email protected]:"
- "py-scikit-learn@0.18:"
- "py-segmentation-models-pytorch@0.2:"
- "py-setuptools@30.4:"
- "py-sphinx@3:"
- "[email protected]:"
- py-torchmetrics
- "py-torchmetrics"
- "[email protected]:"
concretization: together

0 comments on commit d9d8699

Please sign in to comment.