Skip to content

Polish optional FastAPI addon docs and packaging - #87

Merged
nova-rey merged 1 commit into
APIfrom
codex/implement-phase-8-for-crapssim_api
Nov 13, 2025
Merged

nova-rey merged 1 commit into
APIfrom
codex/implement-phase-8-for-crapssim_api

Conversation

@nova-rey

Copy link
Copy Markdown
Owner

Summary

  • include pydantic in the optional api extra while keeping the FastAPI layer opt-in
  • refresh API overview, roadmap, and design intent docs with [api] install, run, and curl guidance
  • add README cross-links and a Phase 8 report capturing validation notes and follow-ups

Testing

  • PYTHONPATH=. pytest -q

Codex Task

@nova-rey
nova-rey merged commit 1fec313 into API Nov 13, 2025
2 of 4 checks passed
@nova-rey
nova-rey deleted the codex/implement-phase-8-for-crapssim_api branch November 13, 2025 16:43

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

crapssim/README.md

Lines 77 to 85 in 34ddfe1

## Optional Local API
The project ships with an opt-in HTTP API that simply wraps the existing
simulator objects for external tooling. It adds a thin control-and-state surface
that plays nicely with CSC workflows, dashboards, or automation scripts without
changing how the core engine behaves. No additional runtime dependencies are
introduced unless you install the optional extras (for example via
`pip install "crapssim[api]"`).

P1 Badge Document install command for non-existent api extra

The updated docs instruct users to install the API layer via pip install "crapssim[api]", but the packaged project does not expose an api extra—setup.cfg only defines a testing extra and the repository has no build configuration that consumes pyproject.toml’s project.optional-dependencies. Running the advertised command against the released wheel or a local checkout therefore raises ExtrasRequirementError: crapssim 0.x has no such extra 'api', leaving the API addon impossible to install as described. Either add an api extra to the packaging metadata or revert the documentation to a working install path.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant