Add API docs and PyPI publishing#10
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mainthrough GitHub PagesWhy
The package now has public models, provider protocols, four built-in providers, backtest runtimes, a streaming bridge, and a FastAPI service. Flat repository Markdown is no longer sufficient for API discovery. The repository also built distributions in CI but had no guarded, credential-free publication path.
User and maintainer impact
Users get searchable guides plus generated API signatures for models, requests, providers, backtesting, streaming, and server components. Maintainers publish by updating
project.versionand creating a matchingv<version>GitHub Release. The protectedpypienvironment requires approval and only acceptsv*tags.The remaining account-level setup is registering the pending
pineforge-dataTrusted Publisher on PyPI with ownerpineforge-4pass, repositorypineforge-data, workflowrelease.yml, and environmentpypi.Validation
ruff check .ruff format --check src tests scriptsmypy srcpytest— 96 passed, 2 optional Docker tests skippedmkdocs build --strict, including a clean environment with only.[docs]actionlinttwine check --strictfor both artifacts