Skip to content

update readme

update readme #71

Workflow file for this run

name: build ⚙️
on: [ push, pull_request ]
jobs:
build:
name: Conda Build with Python${{ matrix.python-version }}
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.9", "3.10"]
defaults:
run:
shell: bash -l {0}
steps:
- uses: actions/checkout@v3
- name: Install packages
run: |
sudo apt-get -y install pandoc graphviz
- name: Setup Conda (Micromamba) with Python${{ matrix.python-version }}
uses: mamba-org/setup-micromamba@v1
with:
cache-downloads: true
cache-environment: true
environment-file: environment.yml
create-args: >-
conda
python=${{ matrix.python-version }}
- name: Conda and Mamba versions
run: |
conda --version
echo "micromamba: $(micromamba --version)"
- name: Install requirements 📦
run: |
python -m pip install --upgrade pip
pip install -e .
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
if [ -f requirements_dev.txt ]; then pip install -r requirements_dev.txt; fi
- name: Test with pytest ⚙️
run: make test
- name: Lint with flake8 ⚙️
run: make lint
if: matrix.python-version == 3.9
# - name: Check formatting with black ⚙️
# run: black --check --target-version py39 rook tests
# if: matrix.python-version == 3.9
# - name: Build docs 🏗️
# run: make docs
# if: matrix.python-version == 3.9