Skip to content

chore: standardize packaging and docs - #17

Merged
saudzahirr merged 1 commit into
mainfrom
chore/standardize-packaging-and-docs
Aug 18, 2026
Merged

chore: standardize packaging and docs#17
saudzahirr merged 1 commit into
mainfrom
chore/standardize-packaging-and-docs

Conversation

@saudzahirr

Copy link
Copy Markdown
Collaborator

Standardizes packaging metadata and docs presentation for smolpack.

CI

  • Add .github/workflows/python-versions-sync.yml and
    .github/scripts/sync_python_versions.py (copied verbatim from the org
    canonical versions) to keep the supported Python versions in sync.

Packaging

  • Remove the redundant "Programming Language :: Python :: 3 :: Only"
    classifier. requires-python = ">=3.10" already states the supported
    range.
  • No other pyproject.toml changes. Programming Language :: C was already
    present, and the platform-specific Operating System classifiers are kept
    as-is since this project ships a compiled extension module.
  • validate-pyproject pyproject.toml passes and the file still parses with
    tomllib.

Docs

  • Add the project banner at docs/assets/smolpack-banner.png.
  • Show it as the first content of README.md (docs/assets/smolpack-banner.png)
    and docs/index.md (assets/smolpack-banner.png), in plain Markdown.
  • Recase the H1 heading in both files from # smolpack to # SmolPack.
    Only the display heading changed — the package name, imports, badge URLs
    and repository URLs are untouched.

🤖 Generated with Claude Code

@codecov

codecov Bot commented Aug 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

- Add python-versions-sync CI workflow and its sync_python_versions.py
  helper under .github/ to keep supported Python versions in step.
- Drop the redundant "Programming Language :: Python :: 3 :: Only"
  classifier from pyproject.toml; requires-python = ">=3.10" already
  states the supported range.
- Add the project banner at docs/assets/smolpack-banner.png and show it
  as the first content of README.md and docs/index.md.
- Recase the H1 heading in README.md and docs/index.md to "SmolPack".

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@saudzahirr
saudzahirr force-pushed the chore/standardize-packaging-and-docs branch from 4e1edf0 to c8c951f Compare August 18, 2026 10:18
@sonarqubecloud

Copy link
Copy Markdown

@saudzahirr
saudzahirr merged commit 20b07be into main Aug 18, 2026
26 checks passed
@saudzahirr
saudzahirr deleted the chore/standardize-packaging-and-docs branch August 18, 2026 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant