Skip to content

Commit 066ba50

Browse files
committed
chore: add link to tutorial
1 parent c96eb64 commit 066ba50

File tree

3 files changed

+11
-4
lines changed

3 files changed

+11
-4
lines changed

Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: clean fmt lint lint.fix help test
1+
.PHONY: build clean fmt lint lint.fix help test
22

33
.DEFAULT_GOAL := help
44

@@ -11,6 +11,9 @@ else
1111
VERSION ?= $(shell bash -c "grep -e '^version' pyproject.toml | sed 's/.*= //'")
1212
endif
1313

14+
build: # Build the SDK into source distributions and wheel
15+
uv build
16+
1417
clean: # Removes local .venv directories and cleans up Docker containers and images associated with this project.
1518
rm -rf $(ROOTDIR)/.venv
1619

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,15 @@ This project is a Python SDK for the F5 AI Gateway Processors specification.
88
It is designed to be used as a base for building a [Starlette](https://www.starlette.io/) application that
99
implements Python based Processors for the AI Gateway.
1010

11+
## Creating a processor
12+
13+
[Processor development quickstart tutorial](https://aigateway.clouddocs.f5.com/sdk/python/tutorial.html)
14+
1115
## Testing
1216

13-
Please look to [the instructions for running the tests locally here](./tests/README.md#executing-tests-locally).
17+
[Instructions for running the tests](./tests/README.md#executing-tests).
1418

15-
## Formatting and Linting
19+
## Formatting and ilnting
1620

1721
This project uses [Ruff](https://docs.astral.sh/ruff/) for formatting and linting.
1822

tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Follows the `pytest` format with the flexibility of adopting `unittest.TestCase` as deemed needed for the flexibility of moving forward quickly.
44

5-
## Executing Tests Locally
5+
## Executing Tests
66

77
## Prerequisites
88

0 commit comments

Comments
 (0)