Adding DOI to CITATION.cff and README.md #261
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Build | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| jobs: | |
| test-python: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| max-parallel: 4 | |
| matrix: | |
| python-version: ["3.10", 3.11, 3.12] | |
| os: [ubuntu-latest, windows-latest, macOS-latest] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python ${{ matrix.python-version }} for Linux | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip setuptools wheel | |
| pip install ".[dev]" | |
| pip install -e . | |
| - name: Run pytests and generate coverage report | |
| run: | | |
| pytest --cov=./ --cov-report=xml | |
| - name: Upload coverage to Codecov | |
| if: ${{ (matrix.python-version == 3.12) && (runner.os == 'Linux') }} | |
| uses: codecov/codecov-action@v5 | |
| with: | |
| fail_ci_if_error: true | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| verbose: true | |
| test-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: "3.10" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip setuptools wheel | |
| pip install ".[dev]" | |
| - name: Run doctests and build html files | |
| run: | | |
| cd docs | |
| make doctest | |
| make html | |
| - name: Run html-proofer | |
| uses: chabad360/htmlproofer@master | |
| with: | |
| directory: docs/build/html | |
| arguments: --allow_hash_href --ignore-files "docs/build/html/search.html" | |
| lint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v1 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v1 | |
| with: | |
| python-version: "3.10" | |
| - name: Install Dependencies | |
| run: | | |
| python -m pip install --upgrade pip setuptools wheel | |
| pip install ".[dev]" | |
| - name: Lint with flake8 | |
| run: | | |
| flake8 aguaclara --count --verbose --show-source --statistics | |
| - name: Check with black | |
| run: | | |
| black --check aguaclara |