Skip to main content

Vendor internal packages from private PyPI for offline production deployments

Project description

Poetry Vendor Plugin

PyPI version Python versions

Vendor internal packages from private PyPI repositories for offline/air-gapped production deployments.

The Problem

You have internal Python packages hosted on a PyPI server inside your company LAN. Development machines can reach it, but production servers cannot (either air-gapped or on a different network). You need a way to bundle those internal packages as wheels into your project so production can install them without network access.

The Solution

This plugin adds poetry vendor pull — a command that downloads your configured internal packages as wheels into a vendor/ directory. You commit those wheels, and production installs from them using Poetry path dependencies.

Installation

Poetry plugins are installed into Poetry's own environment:

poetry self add poetry-vendor-plugin

Verify the plugin is loaded:

poetry self show plugins

Example

See the example/ directory for a complete, runnable project that configures one private PyPI server and two vendored packages.

Usage

1. Configure vendor packages in your project

Add to your project's pyproject.toml:

[tool.vendor]
vendor-dir = "vendor"

[tool.vendor.server]
internal = "https://internal-pypi.company.local/simple/"

[tool.vendor.packages.internal]
my-build-tools = "^1.0.0"
my-ui-elements = ">=2.0.0,<3.0.0"

2. Pull vendor packages

poetry vendor pull

This downloads wheels to vendor/:

vendor/
├── my_build_tools.whl
├── my_ui_elements.whl
└── vendor.lock

The wheel files use stable, version-less names, and vendor.lock records the resolved versions. Commit both the wheels and the lock file.

3. Use path dependencies in production

In your pyproject.toml, switch to path dependencies for production builds:

[tool.poetry.dependencies]
python = "^3.11"
requests = "^2.31"
my-build-tools = { path = "vendor/my_build_tools.whl" }
my-ui-elements = { path = "vendor/my_ui_elements.whl" }

4. List vendored packages

poetry vendor list

5. Update vendor packages

poetry vendor update          # Update all
poetry vendor update -p my-build-tools  # Update specific package

Commands

Command Description
poetry vendor pull Download vendor packages to vendor/
poetry vendor pull --force Re-download even if already present
poetry vendor pull --dry-run Preview what would be downloaded
poetry vendor list Show all vendored packages with sizes
poetry vendor update Force re-download all packages

Configuration Reference

[tool.vendor]
vendor-dir = "vendor"  # Directory for vendored wheels (default: "vendor")

[tool.vendor.server]
server1 = "https://..."  # Named private PyPI index URL

[tool.vendor.packages.server1]
package-name = "^1.0.0"  # Package name and PEP 440 version specifier

You can define multiple servers and group packages under the server they come from:

[tool.vendor.server]
internal = "https://internal-pypi.company.local/simple/"
legacy = "https://legacy-pypi.company.local/simple/"

[tool.vendor.packages.internal]
my-build-tools = "^1.0.0"

[tool.vendor.packages.legacy]
old-ui-elements = ">=1.0.0,<2.0.0"

Lock File

After running poetry vendor pull, a <vendor-dir>/vendor.lock file is created. It tracks the resolved version, source, and requested version specifier for each package. Commit this file alongside the wheels so that poetry vendor list can show accurate version information and so updates behave predictably across machines.

Requirements

  • Python 3.9+
  • Poetry 2.0+

License

MIT

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

poetry_vendor_plugin-0.2.0.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

poetry_vendor_plugin-0.2.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file poetry_vendor_plugin-0.2.0.tar.gz.

File metadata

  • Download URL: poetry_vendor_plugin-0.2.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Linux/6.17.0-1018-azure

File hashes

Hashes for poetry_vendor_plugin-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b713b19e26963c4ac4116e25b2c14953fc6e92d4d01f64a1df505f9ce1f659b7
MD5 9ff7fca3b00563a10f11c47022e53805
BLAKE2b-256 a5b3e9d9f00a239fe96978925841e2f20237bf3cd8cca4ddc03f9565496703b5

See more details on using hashes here.

File details

Details for the file poetry_vendor_plugin-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: poetry_vendor_plugin-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.11.15 Linux/6.17.0-1018-azure

File hashes

Hashes for poetry_vendor_plugin-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ad8b639797184ac6a3cdbd6d969307c7e805cdb31c8dd856f9f28b12b8f48ed1
MD5 3d95b53c02df935fe99e9912c09f60bc
BLAKE2b-256 7625fcd38834d8d24d91ab22dd45e84dbf89c65290319da76af612ce0ebdb246

See more details on using hashes here.

Supported by

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