From c96eb64a5e2104257f2c188ad80529e3886898e3 Mon Sep 17 00:00:00 2001 From: Eoin O'Shaughnessy Date: Wed, 21 May 2025 15:45:32 +0100 Subject: [PATCH 1/3] chore: add ci status to readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1b5ea22..6e28dc5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![ci](https://github.com/nginxinc/f5-ai-gateway-sdk-py/actions/workflows/ci.yml/badge.svg)](https://github.com/nginxinc/f5-ai-gateway-sdk-py/actions/workflows/ci.yml) [![FOSSA Status](https://app.fossa.com/api/projects/custom%2B5618%2Ff5-ai-gateway-sdk-py.svg?type=shield&issueType=license)](https://app.fossa.com/projects/custom%2B5618%2Ff5-ai-gateway-sdk-py?ref=badge_shield&issueType=license) [![FOSSA Status](https://app.fossa.com/api/projects/custom%2B5618%2Ff5-ai-gateway-sdk-py.svg?type=shield&issueType=security)](https://app.fossa.com/projects/custom%2B5618%2Ff5-ai-gateway-sdk-py?ref=badge_shield&issueType=security) From 066ba5058b1e49b190c0dcdfa40752f69faefe17 Mon Sep 17 00:00:00 2001 From: Eoin O'Shaughnessy Date: Wed, 21 May 2025 15:52:15 +0100 Subject: [PATCH 2/3] chore: add link to tutorial --- Makefile | 5 ++++- README.md | 8 ++++++-- tests/README.md | 2 +- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 61b2a94..8ca6cd3 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: clean fmt lint lint.fix help test +.PHONY: build clean fmt lint lint.fix help test .DEFAULT_GOAL := help @@ -11,6 +11,9 @@ else VERSION ?= $(shell bash -c "grep -e '^version' pyproject.toml | sed 's/.*= //'") endif +build: # Build the SDK into source distributions and wheel + uv build + clean: # Removes local .venv directories and cleans up Docker containers and images associated with this project. rm -rf $(ROOTDIR)/.venv diff --git a/README.md b/README.md index 6e28dc5..8ba4f07 100644 --- a/README.md +++ b/README.md @@ -8,11 +8,15 @@ This project is a Python SDK for the F5 AI Gateway Processors specification. It is designed to be used as a base for building a [Starlette](https://www.starlette.io/) application that implements Python based Processors for the AI Gateway. +## Creating a processor + +[Processor development quickstart tutorial](https://aigateway.clouddocs.f5.com/sdk/python/tutorial.html) + ## Testing -Please look to [the instructions for running the tests locally here](./tests/README.md#executing-tests-locally). +[Instructions for running the tests](./tests/README.md#executing-tests). -## Formatting and Linting +## Formatting and ilnting This project uses [Ruff](https://docs.astral.sh/ruff/) for formatting and linting. diff --git a/tests/README.md b/tests/README.md index 6688106..c9739f8 100644 --- a/tests/README.md +++ b/tests/README.md @@ -2,7 +2,7 @@ Follows the `pytest` format with the flexibility of adopting `unittest.TestCase` as deemed needed for the flexibility of moving forward quickly. -## Executing Tests Locally +## Executing Tests ## Prerequisites From 2f158bfc7c24c5dab5b8186f59c7420c60d1a91c Mon Sep 17 00:00:00 2001 From: Eoin O'Shaughnessy Date: Wed, 21 May 2025 15:54:45 +0100 Subject: [PATCH 3/3] chore: fix name of linter action --- .github/workflows/linters.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml index 564525b..12678aa 100644 --- a/.github/workflows/linters.yml +++ b/.github/workflows/linters.yml @@ -10,7 +10,7 @@ on: - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+" jobs: - build: + linters: runs-on: ubuntu-latest steps: @@ -19,7 +19,6 @@ jobs: with: fetch-depth: 0 - # Validate Python code follows coding standard - name: Read .tool-versions uses: marocchino/tool-versions-action@18a164fa2b0db1cc1edf7305fcb17ace36d1c306 # v1.2.0 id: versions