From 28b8fe04e7116bcc0234df36254985de290c25e9 Mon Sep 17 00:00:00 2001 From: Tyler Smart <40041862+tjsmart@users.noreply.github.com> Date: Tue, 25 Oct 2022 05:51:58 -0700 Subject: [PATCH] twine: add examples (#8924) --- pages/common/twine.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/pages/common/twine.md b/pages/common/twine.md index 1afc218a93..a6b1f2ac2d 100644 --- a/pages/common/twine.md +++ b/pages/common/twine.md @@ -1,17 +1,16 @@ # twine > Utility for publishing Python packages on PyPI. -> Subcommands such as `twine upload` have their own usage documentation. -> More information: . - -- Upload to the Test PyPI [r]epository and verify things look right: - -`twine upload -r testpypi dist/*` +> More information: . - Upload to PyPI: `twine upload dist/*` +- Upload to the Test PyPI [r]epository to verify things look right: + +`twine upload -r testpypi dist/*` + - Upload to PyPI with a specified [u]sername and [p]assword: `twine upload -u {{username}} -p {{password}} dist/*` @@ -19,3 +18,19 @@ - Upload to an alternative repository URL: `twine upload --repository-url {{repository_url}} dist/*` + +- Check that your distribution's long description should render correctly on PyPI: + +`twine check dist/*` + +- Upload using a specific pypirc configuration file: + +`twine upload --config-file {{configuration_file}} dist/*` + +- Continue uploading files if one already exists (only valid when uploading to PyPI): + +`twine upload --skip-existing dist/*` + +- Upload to PyPI showing detailed information: + +`twine upload --verbose dist/*`