Skip to content
📦 一个快速搭建 Python Package 的模版
Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
package_name
.gitignore
LICENSE
MANIFEST.in
README.md
requirements.txt
requirements_dev.txt
setup.py
upload_pypi.sh

README.md

Python Package Template

📦 一个快速搭建 Python Package 的模版。

使用方法

  1. 点击本项目右上角的绿色按钮 Use this template(使用此模板),输入名称和说明,完成创建;

  2. 将项目克隆到本地,这里以本项目为例,实际操作时这里需要替换你自己的项目;

    git clone https://github.com/HaveTwoBrush/python-package-template.git --depth 1
  3. 修改配置,文件中有提示;

    cd python-package-template
    
    # 1. 将下文中的 your_package_name 改成你的实际项目名称
    mv package_name your_package_name
    
    # 2. 接下来修改 `setup.py /package_name/shell/usage.py`中的参数,里面有提示。
    
    # 3. 最后 `README.md` 修改为你的项目介绍,也就是你当前在读的这个文本。
  4. 编写你的 Package 代码;

  5. 上传到 PyPi(需要注册),参考如何发布自己的包到 pypi ;

    bash upload_pypi.sh
  6. 更新到 Github。

    git push

项目结构

.
├── package_name # 你需要手动修改为你的项目名称
│   ├── shell # 在命令行中执行的代码
│   │   ├── __init__.py
│   │   └── usage.py
│   ├── src # 静态资源
│   │   └── temp.txt
│   └── version.py # 版本号
├── setup.py # 安装配置
├── requirements.txt # 包依赖
├── requirements_dev.txt # 开发依赖
├── README.md # 项目文档
├── LICENSE # 这里面的内容为本项目的 License,你需要手动替换它。
├── .gitignore
└── upload_pypi.sh # 上传到 PyPi 的工具

许可

参考

You can’t perform that action at this time.