pypiserver 使用教程

1. 项目介绍

pypiserver 是一个轻量级的 PyPI 兼容服务器，用于通过 pip 或 easy_install 上传和下载 Python 包。它基于 bottle 框架，并从常规目录中提供包服务。支持上传 .whl、.bdists、.eggs 及其对应的 PGP 签名文件。

主要特点

• 简单易用：只需几行命令即可启动一个 PyPI 服务器。
• 兼容性强：支持标准的 Python 包管理工具，如 pip 和 twine。
• 灵活配置：可以通过命令行参数或配置文件进行详细配置。

2. 项目快速启动

安装

首先，确保你已经安装了 Python 3.6+ 和 pip。然后使用以下命令安装 pypiserver：

pip install pypiserver

启动服务器

创建一个目录用于存放你的 Python 包：

mkdir ~/packages

将你的包文件（如 .whl、.tar.gz 等）复制到 ~/packages 目录中。然后启动 pypiserver：

pypi-server run -p 8080 ~/packages &

客户端配置

在客户端机器上，配置 pip 使用你的 pypiserver：

pip install --extra-index-url http://localhost:8080/simple/ package_name

3. 应用案例和最佳实践

私有包管理

在企业内部，可以使用 pypiserver 搭建一个私有的 PyPI 服务器，用于管理和分发内部开发的 Python 包。这样可以避免将内部代码上传到公共的 PyPI 服务器，同时加快包的安装速度。

持续集成

在持续集成（CI）环境中，pypiserver 可以作为一个临时的包存储库，用于测试和部署。例如，在 Jenkins 或 GitLab CI 中，可以将构建的包上传到 pypiserver，然后在测试环境中使用这些包。

离线部署

在无法访问互联网的环境中，可以使用 pypiserver 搭建一个本地的 PyPI 服务器，用于离线安装和管理 Python 包。

4. 典型生态项目

twine

twine 是一个用于上传 Python 包到 PyPI 的工具。它可以与 pypiserver 结合使用，将包上传到本地的 pypiserver 实例。

twine upload --repository-url http://localhost:8080/simple/ dist/*

pip

pip 是 Python 的包管理工具，可以直接从 pypiserver 安装包。

pip install --extra-index-url http://localhost:8080/simple/ package_name

setuptools

setuptools 是 Python 的打包和分发工具，可以与 pypiserver 结合使用，上传和管理包。

python setup.py sdist upload -r http://localhost:8080/simple/

通过这些工具的结合使用，可以构建一个完整的 Python 包管理生态系统。