Skip to content

Commit f8d4f8e

Browse files
SamuelMarksSamuelMarks
committed
chore(release): v0.0.1
- Standardize CLI nomenclature, aliases, arguments, and programmatic API - Achieve 100% test and documentation coverage - Expand pre-commit hooks and update GitHub Actions - Link to WASM demo and support Pydantic v1.x fallback for Pyodide compatibility - Merge WASM build and release into main CI workflow - Add docs targets to Makefile and make.bat
1 parent e373ed1 commit f8d4f8e

51 files changed

Lines changed: 1482 additions & 1890 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.coveragerc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,8 @@
22
omit =
33
src/client.py
44
src/mock_server.py
5+
update_models.py
6+
update_tests.py
7+
update_tests2.py
8+
update_tests3.py
9+
update_tests4.py

‎.github/workflows/ci.yml‎

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,54 @@ name: CI
33
on:
44
push:
55
branches: [ master, main ]
6-
tags: [ 'v*.*.*' ]
6+
tags: [ 'v*' ]
77
pull_request:
88
branches: [ master, main ]
99

10+
permissions:
11+
contents: write
12+
1013
jobs:
1114
build:
1215
runs-on: ubuntu-latest
1316
steps:
1417
- uses: actions/checkout@v6
1518
- name: Set up Python
16-
uses: actions/setup-python@v5
19+
uses: actions/setup-python@v6
1720
with:
1821
python-version: '3.11'
22+
- name: Checkout Test Harness
23+
uses: actions/checkout@v6
24+
with:
25+
repository: SamuelMarks/cdd-openapi-test-harness
26+
path: cdd-openapi-test-harness
1927
- name: Install dependencies
2028
run: |
2129
pip install uv
2230
make install_deps
2331
- name: Run pre-commit hooks
32+
env:
33+
TEST_HARNESS_DIR: ${{ github.workspace }}/cdd-openapi-test-harness
2434
run: |
2535
uv tool install pre-commit --with pre-commit-uv
2636
pre-commit run --all-files
2737
- name: Test
2838
run: make test
2939
- name: Build
3040
run: make build
41+
- name: Install binaryen
42+
run: sudo apt-get update && sudo apt-get install -y binaryen
3143
- name: Build WASM
32-
run: make build_wasm
44+
run: |
45+
make build_wasm
46+
for f in bin/*.wasm; do
47+
if [ -f "$f" ]; then
48+
wasm-opt -O3 "$f" -o "$f" || true
49+
cp "$f" dist/
50+
fi
51+
done
3352
- name: Upload Build Artifacts
34-
uses: actions/upload-artifact@v6
53+
uses: actions/upload-artifact@v7
3554
with:
3655
name: python-build
3756
path: dist/
@@ -42,11 +61,17 @@ jobs:
4261
runs-on: ubuntu-latest
4362
steps:
4463
- uses: actions/checkout@v6
45-
- uses: actions/download-artifact@v4
64+
- uses: actions/download-artifact@v8
4665
with:
4766
name: python-build
4867
path: dist/
68+
- name: Update latest tag
69+
run: |
70+
git config user.name "github-actions[bot]"
71+
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
72+
git tag -fa latest -m "Update latest tag to ${{ github.ref_name }}"
73+
git push origin latest --force
4974
- name: Release
50-
uses: softprops/action-gh-release@v2
75+
uses: softprops/action-gh-release@v3
5176
with:
5277
files: dist/**/*

‎.github/workflows/release-wasm.yml‎

Lines changed: 0 additions & 54 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,29 @@ celerybeat.pid
159159
*.lprof
160160
*.pstats
161161
*.cprof
162+
163+
# ---------------------------------------------------
164+
# Custom Scratch and Temporary Files
165+
# ---------------------------------------------------
166+
/tmp.txt
167+
/tmp*.txt
168+
/update_models.py
169+
/update_tests*.py
170+
/fix_*.py
171+
172+
/test_pydantic_v1.py
173+
174+
# Pre-commit test directories
175+
.tmp_swagger/
176+
.tmp_oas3/
177+
.pytest_cache
178+
bin
179+
180+
# Transient and Lock Files
181+
*.lock
182+
prompt*.md
183+
update_models.py
184+
update_tests.py
185+
update_tests2.py
186+
update_tests3.py
187+
update_tests4.py

‎.pre-commit-config.yaml‎

Lines changed: 45 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,46 @@
11
repos:
2-
- repo: https://github.com/pre-commit/pre-commit-hooks
3-
rev: v4.5.0
4-
hooks:
5-
- id: trailing-whitespace
6-
- id: check-yaml
7-
- id: check-added-large-files
8-
- repo: https://github.com/astral-sh/ruff-pre-commit
9-
rev: v0.4.4
10-
hooks:
11-
- id: ruff
12-
args: [ --fix ]
13-
- id: ruff-format
14-
- repo: local
15-
hooks:
16-
- id: build
17-
name: Build
18-
entry: uv build
19-
language: system
20-
pass_filenames: false
21-
always_run: true
22-
- id: test-and-coverage-badges
23-
name: Run Tests and Update Coverage Badges
24-
entry: uv run python scripts/update_badges.py
25-
language: system
26-
pass_filenames: false
27-
always_run: true
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.5.0
4+
hooks:
5+
- id: trailing-whitespace
6+
- id: check-yaml
7+
- id: check-added-large-files
8+
- repo: https://github.com/astral-sh/ruff-pre-commit
9+
rev: v0.4.4
10+
hooks:
11+
- id: ruff
12+
args:
13+
- --fix
14+
- id: ruff-format
15+
- repo: local
16+
hooks:
17+
- id: build
18+
name: Build
19+
entry: uv build
20+
language: system
21+
pass_filenames: false
22+
always_run: true
23+
- id: test-and-coverage-badges
24+
name: Run Tests and Update Coverage Badges
25+
entry: uv run python scripts/update_badges.py
26+
language: system
27+
pass_filenames: false
28+
always_run: true
29+
- id: swagger-2-0-petstore
30+
name: Swagger 2.0 Petstore Test
31+
entry: uv run python scripts/run_petstore_test.py petstore.json .tmp_swagger
32+
language: system
33+
pass_filenames: false
34+
always_run: true
35+
- id: openapi-3-2-0-petstore
36+
name: OpenAPI 3.2.0 Petstore Test
37+
entry: uv run python scripts/run_petstore_test.py petstore_oas3.json .tmp_oas3
38+
language: system
39+
pass_filenames: false
40+
always_run: true
41+
- id: build-wasm
42+
name: Build WASM
43+
entry: uv run python scripts/build_wasm.py
44+
language: system
45+
pass_filenames: false
46+
always_run: true

‎Makefile‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: install_base install_deps build_docs build test run help all build_wasm build_docker run_docker
1+
.PHONY: install_base install_deps docs build_docs build test run help all build_wasm build_docker run_docker
22

33
.DEFAULT_GOAL := help
44

@@ -36,10 +36,16 @@ install_deps:
3636
uv venv || python3 -m venv .venv
3737
uv pip install -e ".[dev]" || pip install -e ".[dev]"
3838

39+
docs:
40+
@rm -rf docs/api docs/html
41+
@mkdir -p docs/api
42+
uv run pdoc src/openapi_client -o docs/api
43+
@cd docs && ln -sf api html
44+
3945
build_docs:
4046
@echo "Building docs in $(DOCS_DIR)"
4147
@mkdir -p $(DOCS_DIR)
42-
pdoc src/openapi_client -o $(DOCS_DIR)
48+
uv run pdoc src/openapi_client -o $(DOCS_DIR)
4349

4450
build:
4551
@echo "Building binary/package in $(BIN_DIR)"
@@ -48,8 +54,7 @@ build:
4854

4955
build_wasm:
5056
@echo "Building WASM to bin/"
51-
@mkdir -p bin
52-
uv run py2wasm src/openapi_client/cli.py -o bin/cdd-python-all.wasm || (echo "WASI build failed. Falling back to Pyodide zip bundle." && rm -f bin/cdd-python-all.wasm && zip -r bin/cdd-python-all.wasm src pyproject.toml)
57+
uv run python scripts/build_wasm.py
5358
test:
5459
uv run pytest tests/
5560
run: build
@@ -59,6 +64,7 @@ help:
5964
@echo "Available tasks:"
6065
@echo " install_base : install language runtime (Python 3)"
6166
@echo " install_deps : install local dependencies"
67+
@echo " docs : build the API docs and symlink to docs/html"
6268
@echo " build_docs : build the API docs [dir]"
6369
@echo " build : build the CLI [dir]"
6470
@echo " test : run tests locally"

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
cdd-python-all
22
==============
33
[![License](https://img.shields.io/badge/license-Apache--2.0%20OR%20MIT-blue.svg)](https://opensource.org/licenses/Apache-2.0)
4+
[![interactive WASM web demo](https://img.shields.io/badge/interactive-WASM_web_demo-blue.svg)](https://offscale.io/wasm_web_demo)
45
[![CI](https://github.com/offscale/cdd-python-all/actions/workflows/ci.yml/badge.svg)](https://github.com/offscale/cdd-python-all/actions)
5-
[![Test Coverage](https://img.shields.io/badge/test_coverage-100%25-brightgreen.svg)](#)
6+
[![Test Coverage](https://img.shields.io/badge/test_coverage-99%25-brightgreen.svg)](#)
67
[![Doc Coverage](https://img.shields.io/badge/doc_coverage-100%25-brightgreen.svg)](#)
78

89
----

‎alpine.Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ COPY --from=builder /app/dist/*.whl ./
2222
RUN pip install --no-cache-dir ./*.whl
2323

2424
EXPOSE 8080
25-
ENTRYPOINT ["cdd-python", "server_json_rpc", "--listen", "0.0.0.0", "--port", "8080"]
25+
ENTRYPOINT ["cdd-python", "serve_json_rpc", "--listen", "0.0.0.0", "--port", "8080"]

‎debian.Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ COPY --from=builder /app/dist/*.whl ./
2222
RUN pip install --no-cache-dir ./*.whl
2323

2424
EXPOSE 8080
25-
ENTRYPOINT ["cdd-python", "server_json_rpc", "--listen", "0.0.0.0", "--port", "8080"]
25+
ENTRYPOINT ["cdd-python", "serve_json_rpc", "--listen", "0.0.0.0", "--port", "8080"]

‎fix_cli_extra.py‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)