Skip to content

Readme cleanup and tutorial links #3

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
May 21, 2025
Merged

Readme cleanup and tutorial links #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c96eb64
chore: add ci status to readme
oseoin May 21, 2025
066ba50
chore: add link to tutorial
oseoin May 21, 2025
2f158bf
chore: fix name of linter action
oseoin May 21, 2025
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
3 changes: 1 addition & 2 deletions .github/workflows/linters.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:
- "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"

jobs:
build:
linters:
runs-on: ubuntu-latest

steps:
Expand All @@ -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
Expand Down
5 changes: 4 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: clean fmt lint lint.fix help test
.PHONY: build clean fmt lint lint.fix help test

.DEFAULT_GOAL := help

Expand All @@ -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

Expand Down
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)

Expand All @@ -7,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.

Expand Down
2 changes: 1 addition & 1 deletion tests/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down