Improve README #1141
This file contains 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
# This workflow will install Python dependencies, run tests | |
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
name: tests | |
on: | |
push: | |
branches: [ main ] | |
pull_request: | |
schedule: | |
- cron: '14 3 * * 1' # at 03:14 on Monday. | |
jobs: | |
pytest: | |
runs-on: ${{ matrix.os }} | |
strategy: | |
fail-fast: false | |
matrix: | |
python-version: | |
- "3.13" | |
- "3.12" | |
- "3.11" | |
- "3.10" | |
os: | |
- ubuntu-latest | |
services: | |
# Label used to access the service container | |
mlflow: | |
# Docker Hub image | |
image: pythonf/mlflow:v2.16.0 | |
options: >- | |
--health-cmd="curl --fail http://localhost:5000/health || exit 1" | |
--health-interval=10s | |
--health-timeout=5s | |
--health-retries=5 | |
ports: | |
- 5000:5000 | |
aim: | |
# Docker Hub image | |
image: pythonf/aim:v3.24.0 | |
options: >- | |
--health-cmd="curl --fail http://localhost:43800/status || exit 1" | |
--health-interval=10s | |
--health-timeout=5s | |
--health-retries=5 | |
ports: | |
- 43800:43800 | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Install uv and set the python version | |
uses: astral-sh/setup-uv@v5 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install the project | |
run: uv sync --all-extras --dev | |
- name: Setup git user | |
run: | | |
git config --global user.name "John Doe" | |
git config --global user.email johndoe@example.com | |
git config --global init.defaultBranch "main" | |
- name: Pytest | |
run: | | |
uv run python --version | |
uv run coverage run -m pytest --benchmark-autosave -vv | |
uv run coverage xml | |
uv run coverage lcov | |
uv run py.test-benchmark compare --csv=export.csv | |
- name: Coveralls | |
uses: coverallsapp/github-action@master | |
with: | |
github-token: ${{ secrets.GITHUB_TOKEN }} | |
path-to-lcov: coverage.lcov | |
- uses: codecov/codecov-action@v2 | |
with: | |
flags: fulltest | |
verbose: true | |
# nbtest: | |
# runs-on: ubuntu-latest | |
# needs: [ pytest ] | |
# steps: | |
# - uses: actions/checkout@v2 | |
# - name: Set up Python 3.11 | |
# uses: actions/setup-python@v4 | |
# with: | |
# python-version: "3.11" | |
# - name: Install Poetry | |
# uses: snok/install-poetry@v1 | |
# with: | |
# virtualenvs-create: true | |
# virtualenvs-in-project: true | |
# - name: Install package | |
# run: | | |
# poetry install | |
# - name: Setup git user | |
# run: | | |
# git config --global user.name "John Doe" | |
# git config --global user.email johndoe@example.com | |
# git config --global init.defaultBranch "main" | |
# - name: Pytest | |
# run: | | |
# poetry run pytest --nbmake ./examples | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Install uv and set the python version | |
uses: astral-sh/setup-uv@v5 | |
with: | |
python-version: "3.12" | |
- name: Install the project | |
run: uv sync --all-extras --dev | |
- name: Install pandoc | |
run: | | |
sudo apt update | |
sudo apt install pandoc | |
- name: Setup git user | |
run: | | |
git config --global user.name "John Doe" | |
git config --global user.email johndoe@example.com | |
git config --global init.defaultBranch "main" | |
- name: Build documentation | |
run: | | |
cd docs | |
uv run make html |