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

Lupl/add mypy action #214

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 19 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
16 changes: 8 additions & 8 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ jobs:
steps:
- uses: actions/checkout@v4

- name: Set up Python 3.11
uses: actions/setup-python@v4
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
python-version: 3.11
version: "0.5.26"

- name: Install Poetry
run: pipx install poetry
enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Install dependencies
run: poetry install --only dev
run: uv sync --no-group examples

- name: Build MkDocs
run: poetry run mkdocs build --strict
run: uv run mkdocs build --strict

- name: Deploy MkDocs
if: github.ref == 'refs/heads/main'
run: poetry run mkdocs gh-deploy --force
run: uv run mkdocs gh-deploy --force
26 changes: 19 additions & 7 deletions .github/workflows/deptry.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
#SPDX-FileCopyrightText: 2024 Birger Schacht
#SPDX-License-Identifier: MIT
name: Run deptry dependency checker

on: [push, pull_request]

jobs:
deptry:
uses: acdh-oeaw/prosnet-workflows/.github/workflows/[email protected]
with:
src: "."
python-version: "3.12"
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.26"

enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Install dependencies
run: uv sync --dev

- name: Run deptry
run: uv run deptry .
24 changes: 24 additions & 0 deletions .github/workflows/mypy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: mypy

on: [push, pull_request]

jobs:
run-mypy:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.26"

enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Install dependencies
run: uv sync --dev

- name: Run mypy
run: uv run mypy rdfproxy/
28 changes: 20 additions & 8 deletions .github/workflows/ruff-formatter.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,25 @@
#SPDX-FileCopyrightText: 2023 Birger Schacht
#SPDX-License-Identifier: MIT
name: Run ruff formatter

on: [push, pull_request]


jobs:
ruff:
uses: acdh-oeaw/prosnet-workflows/.github/workflows/[email protected]
with:
src: "."
options: "format --check"
python-version: "3.12"
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.26"

enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Install dependencies
run: uv sync --dev

- name: Run ruff
run: uv run ruff format --check .
26 changes: 19 additions & 7 deletions .github/workflows/ruff-linter.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,24 @@
#SPDX-FileCopyrightText: 2023 Birger Schacht
#SPDX-License-Identifier: MIT
name: Run ruff linter

on: [push, pull_request]

jobs:
ruff:
uses: acdh-oeaw/prosnet-workflows/.github/workflows/[email protected]
with:
src: "."
python-version: "3.12"
docs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.26"

enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Install dependencies
run: uv sync --dev

- name: Run ruff
run: uv run ruff check .
26 changes: 13 additions & 13 deletions .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,26 @@ jobs:
with:
python-version: ${{ matrix.python-version }}

- name: Install Poetry
run: pipx install poetry

- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.26"

enable-cache: true
cache-dependency-glob: "uv.lock"

- name: Display Python version
run: python -c "import sys; print(sys.version)"

- name: Install dependencies
run: poetry install --no-interaction --no-root

- name: Install project
run: poetry install --no-interaction

- name: Run pytest
run: |
# source .venv/bin/activate
poetry run pytest tests/
run: uv sync --no-group examples

- name: Run tests
run: uv run pytest tests

- name: Run pyest-cov
run: |
poetry run pytest --cov rdfproxy/ --cov-report xml
uv run pytest --cov rdfproxy/ --cov-report xml

- name: Upload coverage data to coveralls
uses: coverallsapp/[email protected]
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# RDFProxy

![tests](https://github.com/acdh-oeaw/rdfproxy/actions/workflows/tests.yaml/badge.svg)
![tests](https://github.com/acdh-oeaw/rdfproxy/actions/workflows/tests.yml/badge.svg)
[![coverage](https://coveralls.io/repos/github/acdh-oeaw/rdfproxy/badge.svg?branch=main&kill_cache=1)](https://coveralls.io/github/acdh-oeaw/rdfproxy?branch=main&kill_cache=1)
[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
[![docs](https://github.com/acdh-oeaw/rdfproxy/actions/workflows/deploy-docs.yml/badge.svg)](https://acdh-oeaw.github.io/rdfproxy/)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)

Functionality for mapping SPARQL result sets to Pydantic models.

Expand Down
10 changes: 2 additions & 8 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,10 @@

## Running examples

First, install the examples dependency group:
To run examples, execute `uv run`:

```shell
poetry install --with examples
```

Then, run `fastapi` on an example file

```shell
poetry run fastapi dev <example.py>
uv run fastapi dev examples/<path-to-examples>
```

This will run the FastAPI application on `http://127.0.0.1:8000`.
Loading