Skip to content

Commit a8764e4

Browse files
committed
ci(setuptools): add long_description
Warning: You are using "pypa/gh-action-pypi-publish@master". The "master" branch of this project has been sunset and will not receive any updates, not even security bug fixes. Please, make sure to use a supported version. If you want to pin to v1 major version, use "pypa/gh-action-pypi-publish@release/v1". If you feel adventurous, you may opt to use use "pypa/gh-action-pypi-publish@unstable/v1" instead. A more general recommendation is to pin to exact tags or commit shas. Warning: It looks like you are trying to use an API token to authenticate in the package index and your token value does not start with "pypi-" as it typically should. This may cause an authentication error. Please verify that you have copied your token properly if such an error occurs. Checking dist/kiwi_json-0.10.0-py3-none-any.whl: FAILED ERROR `long_description` has syntax errors in markup and would not be rendered on PyPI. No content rendered from RST source. WARNING `long_description_content_type` missing. defaulting to `text/x-rst`. Checking dist/kiwi-json-0.10.0.tar.gz: PASSED with warnings WARNING `long_description_content_type` missing. defaulting to `text/x-rst`. WARNING `long_description` missing.
1 parent f41f39a commit a8764e4

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
bdist_wheel
3232
- name: Publish distribution 📦 to PyPI
3333
if: startsWith(github.ref, 'refs/tags')
34-
uses: pypa/gh-action-pypi-publish@master
34+
uses: pypa/gh-action-pypi-publish@release/v1
3535
with:
3636
user: __token__
3737
password: ${{ secrets.pypi_password }}

setup.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
with open("test-requirements.txt") as f:
77
TEST_REQUIREMENTS = f.read().splitlines()
88

9+
# read the contents of your README file
10+
from pathlib import Path
11+
12+
this_directory = Path(__file__).parent
13+
long_description = (this_directory / "README.md").read_text()
14+
915
setup(
1016
name="kiwi-json",
1117
version="0.10.0",
@@ -16,6 +22,8 @@
1622
install_requires=REQUIREMENTS,
1723
tests_require=TEST_REQUIREMENTS,
1824
description="DRY JSON encoder.",
25+
long_description=long_description,
26+
long_description_content_type="text/markdown",
1927
include_package_data=True,
2028
classifiers=[
2129
"Development Status :: 4 - Beta",

0 commit comments

Comments
 (0)