A small example nester
Project description
Ultramax Package
This is a nester package. You can use Github-flavored Markdown to write your content.
|-- package/ | |-- dist/ | |-- src/ | | |-- kingnest/ | | | |-- init.py | | | |-- nest.py | | | |-- 更多模块.py | |-- test/ | |-- LICENSE | |-- pyproject.toml | |-- README.md
目录结构 package/:这是项目的根目录。 dist/:这个目录将包含打包的文件,包括源码分发包(.tar.gz 文件)和轮子分发包(.whl 文件)。这些文件是通过运行 python -m build 生成的。 src/:这个目录包含你的源代码。这是一种常见的目录结构,可以帮助避免一些 Python 导入问题。 kingnest/:这是包的主目录,它包含 Python 源代码。这个目录的名称应该与包名称一致。 init.py:这个文件是一个特殊的文件,它标记 kingnest/ 目录为一个 Python 包,这样它就可以作为一个模块导入了。这个文件可以为空,或者包含初始化代码。 nest.py:这是主要 Python 文件。递归函数在这里。 module1.py: 类和其他代码应在这里 module2.py: module3.py: test/:这个目录包含单元测试。 LICENSE:这个文件列出项目采用的开源许可证。这是非常重要的,因为它定义了其他人可以如何使用你的代码。 pyproject.toml:这是项目的配置文件。在这里,定义项目的元数据(如名称、版本、作者等)以及项目的依赖关系。 README.md:这个文件应该包含项目的介绍和使用说明。这是项目的主要文档,尽可能详细和清晰。
Python 模块打包发布到PyPI:
-
组织代码 目录结构如上
-
创建 pyproject.toml pyproject.toml 是 Python 包的配置文件。在这个文件中指定包的名称、版本、作者、许可证等信息,以及包的依赖关系。 现在 Python 社区推荐使用 pyproject.toml,因为它提供了一种更标准化和灵活的方式来管理包的配置。
-
创建 README.md 和 LICENSE 在项目根目录下创建一个 README.md 文件,说明包是什么,以及如何使用它,并包含一个 LICENSE 文件,指明包的许可证。
-
使用 build 命令来打包你的项目。首先,需要安装 build 模块:
pip install build然后,在你的项目根目录下运行以下命令来打包你的项目:
python -m build这将会在 dist/ 目录下创建一个源代码分发包(.tar.gz 文件)和一个轮子分发包(.whl 文件)。
-
使用 twine 命令来发布包到 PyPI(Python Package Index)。首先,你需要安装 twine:
pip install twine然后,可以运行以下命令来上传你的包:
twine upload dist/*
在这个过程中,要输入 PyPI 用户名和密码。如果还没有 PyPI 账户,可以在 PyPI 网站上创建一个。 启用两用验证后,必须使用API令牌登录 用户名设为 token 密码设置为令牌值,包括pypi-前缀
如果使用Twine来将程序上传至PyPI,像这样来设置$HOME/.pypirc文件,每次上传模块就不用输入用户名密码了。 [pypi] username = token password = pypi-*****
在Linux操作系统中,$HOME是一个环境变量,它指向当前用户的主目录。通常,这个目录位于/home目录下。 当您在终端中执行cd命令时,它会将当前工作目录更改为HOME所指示的目录。
从官方源安装 pip install -i https://pypi.org/simple/ kingnest==0.0.6
临时使用
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple some-package
从文件安装 pip install -r requirements.txt
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file kingnest-0.0.9.tar.gz.
File metadata
- Download URL: kingnest-0.0.9.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17a81734a8d3ef58d1a4c9b78bc42beebee78b1a1ab09d74ee7befe501e98b62
|
|
| MD5 |
bc0f6ee6242148bd58a85ded2399efdf
|
|
| BLAKE2b-256 |
b9bb93ce5188d51b3c1c69d7813753a783c5fae7379f4ed3240d08fde466b3c3
|
File details
Details for the file kingnest-0.0.9-py3-none-any.whl.
File metadata
- Download URL: kingnest-0.0.9-py3-none-any.whl
- Upload date:
- Size: 4.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
77088dc420e7cf2e86a7a0cf4135bb2503aca16eb92999505440999147d886e3
|
|
| MD5 |
d7496a156977b6233fda5e2ec4957768
|
|
| BLAKE2b-256 |
14c84835123d3d6ad317744e846ed55ae7e732ed3612f31364590f85ac712558
|