Skip to main content

A PDM plugin to publish to PyPI

Project description

PDM Publish

ci pypi version code style: black checked with mypy

A PDM plugin to publish to PyPI

NOTE: Consider if you need this over using twine directly

Installation

If you installed pdm via pipx:

pipx inject pdm pdm-publish

or brew:

$(brew --prefix pdm)/libexec/bin/python -m pip install pdm-publish

or pip:

pip install --user pdm-publish

Usage

pdm-publish enables pdm to publish packages to PyPI by wrapping twine internally. For example, to build and publish:

# Using token auth
pdm publish --password token
# To test PyPI using basic auth
pdm publish -r testpypi -u username -P password
# To custom index
pdm publish -r https://custom.index.com/

Full usage:

$ pdm publish --help
Upload artifacts to a remote repository

Usage:

Options:
  -h, --help            show this help message and exit
  -v, --verbose         -v for detailed output and -vv for more detailed
  -g, --global          Use the global project, supply the project root with
                        `-p` option
  -p PROJECT_PATH, --project PROJECT_PATH
                        Specify another path as the project root, which
                        changes the base of pyproject.toml and __pypackages__
  -r REPOSITORY, --repository REPOSITORY
                        The repository name or url to publish the package to
                        [env var: PDM_PUBLISH_REPO]
  -u USERNAME, --username USERNAME
                        The username to access the repository [env var:
                        PDM_PUBLISH_USERNAME]
  -P PASSWORD, --password PASSWORD
                        The password to access the repository [env var:
                        PDM_PUBLISH_PASSWORD]
  --dry-run             Perform all actions except upload the package
  --no-build            Don't build the package before publishing

Configuration

Config Item Description Default Value Available in Project Env var
publish.repo PyPI repo name (pypi/testpypi) or url pypi True PDM_PUBLISH_REPO
publish.username PyPI username __token__ True PDM_PUBLISH_USERNAME
publish.password PyPI password True PDM_PUBLISH_PASSWORD

Links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pdm-publish-0.2.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

pdm_publish-0.2.1-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file pdm-publish-0.2.1.tar.gz.

File metadata

  • Download URL: pdm-publish-0.2.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.8.5 Linux/5.8.0-1033-azure

File hashes

Hashes for pdm-publish-0.2.1.tar.gz
Algorithm Hash digest
SHA256 9ec59ebdb816f86d5fcf8a3f3d9b0afdc57ed07ef420259de0df5dd505d63009
MD5 67d9b00ec820996ef9655b123bf3e4f4
BLAKE2b-256 55887e87ae5e8cea9d0800d3e231f72d8c42034b67856986262849b0e86f0475

See more details on using hashes here.

File details

Details for the file pdm_publish-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: pdm_publish-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.8.5 Linux/5.8.0-1033-azure

File hashes

Hashes for pdm_publish-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ebb3a524511b4449763e67c0c90b90f7ce3301fc018316cfea036778171132be
MD5 745f56dd5af3dc0f2c96b201e67d4106
BLAKE2b-256 0a88b2671dd7b8f4b361c6e1863c4098ff267754095d2da10bedf3aeb139c2d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page