Skip to content

Add project description to PyPI page - #178

Merged
starpit merged 1 commit into
IBM:mainfrom
chibby0ne:add_README_to_pypi_webpage
Aug 7, 2025
Merged

Add project description to PyPI page#178
starpit merged 1 commit into
IBM:mainfrom
chibby0ne:add_README_to_pypi_webpage

Conversation

@chibby0ne

Copy link
Copy Markdown
Contributor

Currently spnl PyPI page has no project description. This is due to the pyproject.toml not including the README.md section.
In addition to that README.md specified in pyproject.toml are not included in binary distributions (i.e: wheel builds) so a source distribution needs to be created as well.
In addition made a small refactor of the --features flag of maturin build according to the documentation.

README.md is not included in binary distributions (i.e: wheel builds) so
a source distribution needs to be created as well.

Signed-off-by: Antonio Gutierrez <chibby0ne@gmail.com>
@starpit

starpit commented Aug 7, 2025

Copy link
Copy Markdown
Member

thanks! i see you added sdist. We may need to confirm that the publish_pypi github action is publishing it (separate PR, if needed)?

@starpit
starpit merged commit 0e2395a into IBM:main Aug 7, 2025
12 checks passed
@chibby0ne
chibby0ne deleted the add_README_to_pypi_webpage branch August 8, 2025 11:09
@chibby0ne

Copy link
Copy Markdown
Contributor Author

thanks! i see you added sdist. We may need to confirm that the publish_pypi github action is publishing it (separate PR, if needed)?

Yeah you're right. It seems it doesn't upload the sdist at the moment 🤔

- name: Upload wheels
uses: actions/upload-artifact@v4
with:
name: build-${{ matrix.os }}-${{matrix.python-version}}-${{ github.sha }}
path: target/wheels/*.whl

path: artifacts1/
- name: List artifacts
run: |
find artifacts1
mkdir artifacts
find artifacts1 -name '*.whl' -exec mv {} artifacts \; -print
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@v1.12.4
with:
packages-dir: artifacts/

Another PR is in order then

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.

2 participants