Skip to content

Commit

Permalink
CI: Github Workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
olivierverdier committed Sep 27, 2024
1 parent 532b01a commit 132c13c
Show file tree
Hide file tree
Showing 4 changed files with 92 additions and 1 deletion.
53 changes: 53 additions & 0 deletions .github/workflows/python_package.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python

name: build

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:
build:

runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12"]

steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install flake8 pytest
pip install .[dev]
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=src
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics --ignore=E231,E226,E302,E301,E225 --exclude=src
- name: Lint with Ruff
run: |
pip install ruff
ruff check --output-format=github --exclude=src .
continue-on-error: true
- name: Test with pytest
run: |
pytest tests
- name: Generate Coverage Report
run: |
pip install coverage
coverage run -m pytest tests
- name: Upload coverage reports to Codecov
uses: codecov/[email protected]
with:
token: ${{ secrets.CODECOV_TOKEN }}
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018--2023 Olivier Verdier

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion Readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Build Status](https://travis-ci.com/olivierverdier/diffeopt.svg?branch=master)](https://travis-ci.com/olivierverdier/diffeopt)
[![Build Status](https://github.com/olivierverdier/diffeopt/actions/workflows/python_package.yml/badge.svg?branch=main)](https://github.com/olivierverdier/diffeopt/actions/workflows/python_package.yml?query=branch%3Amain)

# Diffeopt: optimisation on diffeomorphisms

Expand Down
17 changes: 17 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[project]
name = "diffeopt"
version = "0.1.0"
authors = [{name = "Olivier Verdier", email="[email protected]"}]
description = "Optimisation on Diffeomorphisms"
dependencies = [
"ddmatch @ git+https://github.com/olivierverdier/ddmatch",
"torch",
"numpy",
]
readme = "README.md"
license = {file = "LICENSE"}

[tool.pytest.ini_options]
pythonpath = [
"."
]

0 comments on commit 132c13c

Please sign in to comment.