pypiserver 技术文档

1. 安装指南

1.1 系统要求

• Python 3.6 及以上版本
• PyPy3

1.2 安装步骤

1. 使用以下命令安装 pypiserver：

   pip install pypiserver
   

   或者安装包含 passlib 和 cache 扩展的版本：

   pip install pypiserver[passlib,cache]
   

2. 创建一个目录用于存放包：

   mkdir ~/packages
   

2. 项目的使用说明

2.1 启动服务器

将一些包复制到 ~/packages 目录后，使用以下命令启动 pypiserver：

pypi-server run -p 8080 ~/packages &

该命令将在本地端口 8080 上启动服务器，并监听所有 IP。

2.2 客户端使用

从客户端计算机上，可以使用以下命令安装或搜索托管的包：

# 安装托管的包
pip install --extra-index-url http://localhost:8080/simple/ ...

# 或者
pip install --extra-index-url http://localhost:8080 ...

# 搜索托管的包
pip search --index http://localhost:8080 ...

注意：pip search 目前不支持 /simple/ 端点。

3. 项目API使用文档

3.1 命令行参数

使用 pypi-server -h 可以查看详细的命令行参数说明：

usage: pypi-server [-h] [-v] [--log-file FILE] [--log-stream STREAM]
                  [--log-frmt FORMAT] [--hash-algo HASH_ALGO]
                  [--backend {auto,simple-dir,cached-dir}] [--version]
                  {run,update} ...

3.2 常用命令

• pypi-server run：启动服务器。
• pypi-server update：更新服务器。

4. 项目安装方式

4.1 使用 pip 安装

pip install pypiserver

4.2 使用 Docker 安装

参考项目 Wiki 中的 Docker 使用说明。

4.3 其他安装方法

• 安装最新版本：

  pip install git+https://github.com/pypiserver/pypiserver.git
  

通过以上步骤，您可以顺利安装并使用 pypiserver 项目。