style: add pre-commit for style (#101)

Author: frode-aarstad

.github/scripts/pack.sh

@@ -8,4 +8,4 @@ tar -czvf everest-tutorials-drogon-well_order.tar.gz      ./data/drogon/well_ord
 tar -czvf everest-tutorials-drogon-well_rate.tar.gz       ./data/drogon/well_rate
 tar -czvf everest-tutorials-drogon-well_selection.tar.gz  ./data/drogon/well_selection
 tar -czvf everest-tutorials-drogon-well_swap.tar.gz       ./data/drogon/well_swap
-tar -czvf everest-tutorials-drogon-well_trajectory.tar.gz ./data/drogon/well_trajectory
+tar -czvf everest-tutorials-drogon-well_trajectory.tar.gz ./data/drogon/well_trajectory

.github/workflows/commitlint.yml

@@ -1,6 +1,6 @@
 name: commit lint
 
-on: 
+on:
   workflow_dispatch:
   workflow_call:
   push:
@@ -25,4 +25,4 @@ jobs:
         run: npm install @commitlint/{cli,config-conventional}
 
       - name: run commitlint
-        run: npx commitlint --from=$(git merge-base origin/main HEAD) --to=HEAD
+        run: npx commitlint --from=$(git merge-base origin/main HEAD) --to=HEAD

.github/workflows/publish.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
   workflow_call:
   push:
-    branches: 
+    branches:
       - main
 
 permissions:
@@ -19,16 +19,16 @@ concurrency:
 jobs:
   publish:
     runs-on: ubuntu-latest
-    
+
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    
+
     steps:
       - name: checkout code
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0     
+          fetch-depth: 0
 
       - name: install uv
         uses: astral-sh/setup-uv@v5
@@ -38,15 +38,15 @@ jobs:
 
       - name: build docs
         run: uv run sphinx-build -M html ./docs/source ./docs/build/
-        
+
       - name: setup pages
         uses: actions/configure-pages@v5
-      
+
       - name: upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
           path: './docs/build/html'
-      
+
       - name: deploy to github pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -37,4 +37,4 @@ jobs:
         if: ${{ steps.release.outputs.release_created }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: .github/scripts/upload.sh ${{ steps.release.outputs.tag_name }}
+        run: .github/scripts/upload.sh ${{ steps.release.outputs.tag_name }}

.github/workflows/style.yml

@@ -0,0 +1,41 @@
+name: Style
+
+on:
+  push:
+   branches:
+     - main
+     - 'version-**'
+  pull_request:
+
+jobs:
+  check-style:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.12']
+
+    steps:
+    - uses: actions/checkout@v5
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install with style dependencies
+      run: |
+        uv sync --extra style
+
+    - name: Run style check
+      if: ${{ always() }}
+      run: |
+        SKIP=no-commit-to-branch uv run pre-commit run --all-files --show-diff-on-failure

.gitignore

@@ -179,4 +179,4 @@ cython_debug/
 # PyPI configuration file
 .pypirc
 
-.vscode
+.vscode

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+default_install_hook_types: [pre-commit]
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+    -   id: no-commit-to-branch
+    -   id: check-json
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+        exclude: ^(docs/|data/)
+    -   id: trailing-whitespace
+        exclude: ^(docs/|data/)
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.11
+    hooks:
+    - id: ruff-check
+      args: [ --fix ]
+    - id: ruff-format
+
+-   repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.8.14
+    hooks:
+      - id: uv-lock

CODE_OF_CONDUCT.md

@@ -54,4 +54,4 @@ wish to place an anonymous, confidential report we encourage to use the [Equinor
 Ethics
 helpline](https://secure.ethicspoint.eu/domain/media/en/gui/102166/index.html).
 
-This helpline is hosted by a third party helpline provider.
+This helpline is hosted by a third party helpline provider.

CONTRIBUTING.md

@@ -1,9 +1,9 @@
 # Contributors Guide
 
-Welcome to the **EVEREST™ Tutorials** repository! 
-We appreciate your interest in contributing to this project. 
+Welcome to the **EVEREST™ Tutorials** repository!
+We appreciate your interest in contributing to this project.
 
-We expect all contributors to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). 
+We expect all contributors to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
 Be respectful and inclusive in all interactions.
 
 Below are the guidelines to help you contribute effectively.
@@ -21,8 +21,8 @@ Below are the guidelines to help you contribute effectively.
 
 ## Introduction
 
-The EVEREST Tutorials repository is focused on providing reproducible tutorials for EVEREST. 
-This is a documentation-based repository with examples and configuration files that focus on practical usage. 
+The EVEREST Tutorials repository is focused on providing reproducible tutorials for EVEREST.
+This is a documentation-based repository with examples and configuration files that focus on practical usage.
 Contributors are welcome to improve the tutorials, fix bugs, and suggest enhancements to the documentation.
 
 
@@ -68,7 +68,7 @@ We enforce this linting all commit and pull request messages using the [commitli
 
 #### Commit Message Format
 
-Each commit message consists of a `header`, a `body` and a `footer`. 
+Each commit message consists of a `header`, a `body` and a `footer`.
 The header has a special format that includes a `type`, a `scope` and a `subject`:
 
 ```
@@ -83,7 +83,7 @@ The `header` and the `subject` are mandatory and the rest are optional.
 If there is a `body` you need to add a blank line between the header and the body.
 If there is `footer` you need to add a blank line between the body and the footer.
 
-The footer can contain a `close` or `fixes` keyword to link to the issue and close it when the pull request is merged. 
+The footer can contain a `close` or `fixes` keyword to link to the issue and close it when the pull request is merged.
 This behavior is described in [Linking a pull request to an issue using a keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
 
 The accepted types follow the [Angular convention](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum) and can be:
@@ -119,7 +119,7 @@ chore(main): release 0.4.1
 
 ### Pull Request Guidelines
 
-The format of the pull request message is the same as the commit message. 
+The format of the pull request message is the same as the commit message.
 Ensure your pull request is based on the latest main branch.
 Follow the repository's commit message format.
 Provide a clear description of the changes in the pull request.

README.md

@@ -1,2 +1,29 @@
-# everest-tutorials
-EVEREST Tutorials
+[![Code Style](https://github.com/equinor/everest-tutorials/actions/workflows/style.yml/badge.svg)](https://github.com/equinor/everest-tutorials/actions/workflows/style.yml)
+
+Everest tutorials
+
+
+
+### Style requirements
+
+There are a set of style requirements, which are gathered in the `pre-commit`
+configuration, to have it automatically run on each commit do:
+
+```sh
+pip install pre-commit
+pre-commit install
+```
+
+or before each commit do:
+
+```sh
+pre-commit run --all-files
+```
+
+
+There is also a pre-push hook configured in `pre-commit` to run a collection of
+relatively fast tests, to install this hook:
+
+```sh
+pre-commit install --hook-type pre-push
+```