Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: reuse pre-commit hook and python 3.9+ compatiblity #3

Merged
merged 2 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

# GitHub syntax highlighting
pixi.lock linguist-language=YAML linguist-generated=true
5 changes: 5 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

version: 2

updates:
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

name: build

on:
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/coverage.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

name: Post coverage comment

on:
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/documentation-links.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

name: readthedocs preview
on:
pull_request_target:
Expand Down
7 changes: 6 additions & 1 deletion .github/workflows/pre-commit.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

name: pre-commit

on:
Expand All @@ -13,5 +18,5 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
python-version: "3.9"
- uses: pre-commit/[email protected]
7 changes: 6 additions & 1 deletion .github/workflows/publish-pypi.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

# From https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-pypi

name: Upload Python Package
Expand All @@ -18,7 +23,7 @@ jobs:

- uses: actions/setup-python@v5
with:
python-version: "3.12"
python-version: "3.9"

- name: Build release distributions
run: |
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

Expand Down
8 changes: 2 additions & 6 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <[email protected]>
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
# SPDX-FileContributor: Andre Anjos <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later
Expand Down Expand Up @@ -46,8 +47,3 @@ repos:
rev: v3.0.2
hooks:
- id: reuse
exclude: |
(?x)(
^.pixi/|
^.pixi.lock|
)
5 changes: 3 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# SPDX-FileCopyrightText: Copyright © 2023 Idiap Research Institute <[email protected]>
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

Expand All @@ -7,7 +8,7 @@ version: 2
build:
os: "ubuntu-22.04"
tools:
python: "3.12"
python: "3.9"

python:
install:
Expand Down
10 changes: 0 additions & 10 deletions .reuse/dep5

This file was deleted.

13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<!--
SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
SPDX-FileContributor: Amir Mohammadi <[email protected]>

SPDX-License-Identifier: GPL-3.0-or-later
-->

[![latest-docs](https://img.shields.io/badge/docs-latest-orange.svg)](https://gridtk.readthedocs.io/en/latest/)
[![docs](https://img.shields.io/badge/docs-stable-orange.svg)](https://gridtk.readthedocs.io/en/stable/)
[![build](https://github.com/idiap/gridtk/actions/workflows/build.yml/badge.svg)](https://github.com/idiap/gridtk/actions/workflows/build.yml)
[![coverage](https://raw.githubusercontent.com/idiap/gridtk/python-coverage-comment-action-data/badge.svg)](https://htmlpreview.github.io/?https://github.com/idiap/gridtk/blob/python-coverage-comment-action-data/htmlcov/index.html)
[![repository](https://img.shields.io/badge/github-project-0000c0.svg)](https://github.com/idiap/gridtk)
Expand All @@ -25,22 +26,20 @@ installation, submission, monitoring, and various commands provided by GridTK.
Before diving into GridTK, ensure you have the following prerequisites:

1. A working SLURM setup.
2. [Pixi](https://pixi.sh) installed.
2. [pipx](https://pipx.pypa.io/stable/) installed.
3. GridTK installed (instructions provided below).

## Installation

To install GridTK, open your terminal and run the following command:

```bash
$ pixi global install pipx
$ pixi global install python=3.12
$ pipx install --force --python python3.12 'git+https://github.com/idiap/gridtk.git'
$ pipx install gridtk
```
It is **not recommennded** to install GridTK using `pip install gridtk` in the
same environment as your expeirments. GirdTK does not need to be installed in
the same environment as your experiments and its depencencies may conflict with
your experiments.
your experiments' dependencies.

## Basic Usage

Expand Down
3 changes: 2 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
# SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
# SPDX-FileContributor: Amir Mohammadi <[email protected]>
#
# SPDX-License-Identifier: GPL-3.0-or-later

Expand Down
3 changes: 2 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. SPDX-FileCopyrightText: Copyright © 2022 Idiap Research Institute <[email protected]>
.. SPDX-FileCopyrightText: 2024 Idiap Research Institute <[email protected]>
.. SPDX-FileContributor: Amir Mohammadi <[email protected]>
..
.. SPDX-License-Identifier: GPL-3.0-or-later

Expand Down
Loading
Loading