Repository navigation
docs: accurate package metadata; PyPI name no longer presented as decided (#58) - #231
Merged
Merged
Conversation
…ided (#58) - crates/openquant: documentation points at the published rustdoc (/api/rust/openquant/). - pyproject: Changelog URL; name marked as a placeholder pending the #58 decision. - README, Overview, Quickstart, Python bindings setup: the import name is `openquant`; the PyPI distribution name is not decided yet. - CHANGELOG entry; changelog page regenerated; last_authored bumped. Refs #58 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
6 tasks
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.
Refs #58 (the PyPI distribution name is still an owner decision, so this does not close it).
Re-verified against main
Most of #58 was already fixed by #70 and later PRs:
crates/openquant/Cargo.toml: homepage is the real site,mlfinlabis gone from keywords, repository/readme/license/description are present.crates/pyopenquant/Cargo.toml: repository, readme, homepage andpublish = falseare present.pyproject.toml: accurate description,requires-python = ">=3.11"with 3.11/3.12/3.13 classifiers (CI tests 3.11 and 3.13),[project.urls]present, dependency bounds (numpy<3,polars<2,pyarrow<26) contain the locked versions (numpy 2.4.6, polars 1.44.2, pyarrow 25.0.1).grep -ri openquant-rsfinds only.ai-dlc/work/rel-name-metadata.toml(the mirror of this issue's text).Changed here
crates/openquant/Cargo.toml:documentation→ https://open-quant.github.io/openquant/api/rust/openquant/ (the rustdoc the docs site publishes), instead of the site root.pyproject.toml:ChangelogURL added; a comment marksname = "pyopenquant"as a placeholder pending the Choose a distribution name and make package metadata and README accurate #58 decision (the name itself is unchanged).pyopenquant". They now say the import name isopenquantand the PyPI name is not decided yet, keeping the warning not topip install openquant.last_authoredbumped on the edited pages.Every metadata/badge URL was checked with
curl -Land returns 200: site root,/api/rust/,/api/rust/openquant/,/quickstart/, the repo, issues,CHANGELOG.md, both workflow badges, the shields.io license badge.For the maintainer: GitHub settings (not changed by this PR)
The current description is generic and there are two topics (
finance,machine-learning); the homepage is already set. To finish that item of #58:Left for #58
pyproject.tomland drop the placeholder comment and the "not decided" sentences.🤖 Generated with Claude Code