Plumbum 项目使用文档

Plumbum 项目使用文档

项目地址:https://gitcode.com/gh_mirrors/pl/plumbum

1. 项目的目录结构及介绍

Plumbum 项目的目录结构如下：

plumbum/
├── docs/
├── examples/
├── plumbum/
│   ├── cli/
│   ├── colors.py
│   ├── commands.py
│   ├── factories.py
│   ├── fs.py
│   ├── path.py
│   ├── remote.py
│   ├── shell.py
│   ├── shortcuts.py
│   ├── six.py
│   └── version.py
├── tests/
├── .gitignore
├── LICENSE
├── MANIFEST.in
├── README.md
├── setup.cfg
├── setup.py
└── tox.ini

目录介绍

• docs/: 包含项目的文档文件。
• examples/: 包含示例代码，展示如何使用 Plumbum。
• plumbum/: 核心代码目录，包含各种模块和功能。
  • cli/: 命令行接口相关代码。
  • colors.py: 颜色处理模块。
  • commands.py: 命令执行模块。
  • factories.py: 工厂类模块。
  • fs.py: 文件系统操作模块。
  • path.py: 路径处理模块。
  • remote.py: 远程操作模块。
  • shell.py: shell 相关功能模块。
  • shortcuts.py: 快捷方式模块。
  • six.py: 兼容性模块。
  • version.py: 版本信息模块。
• tests/: 测试代码目录。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• MANIFEST.in: 打包清单文件。
• README.md: 项目说明文档。
• setup.cfg: 安装配置文件。
• setup.py: 安装脚本。
• tox.ini: 自动化测试配置文件。

2. 项目的启动文件介绍

Plumbum 项目的启动文件主要是 setup.py，它负责项目的安装和分发。通过运行 python setup.py install 可以安装 Plumbum 库。

3. 项目的配置文件介绍

Plumbum 项目的主要配置文件是 setup.cfg，它包含了项目的各种配置信息，如安装选项、测试配置等。此外，tox.ini 文件用于配置自动化测试环境。

setup.cfg

[metadata]
name = plumbum
version = attr: plumbum.version.__version__
description = Plumbum: shell combinators library
long_description = file: README.md
long_description_content_type = text/markdown
author = Tomer Filiba
author_email = tomerfiliba@gmail.com
url = https://github.com/tomerfiliba/plumbum
license = MIT
classifiers =
    Development Status :: 5 - Production/Stable
    Intended Audience :: Developers
    License :: OSI Approved :: MIT License
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.6
    Programming Language :: Python :: 3.7
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9
    Programming Language :: Python :: 3.10

[options]
packages = find:
python_requires = >=3.6
install_requires =
    six

[options.packages.find]
where = .

[tool:pytest]
addopts = --doctest-modules
testpaths = tests plumbum

[flake8]
ignore = E203, E266, E501, W503
max-line-length = 88
select = B,C,E,F,W,T4,B9

tox.ini

[tox]
envlist = py36,py37,py38,py39,py310
skipsdist = true

[testenv]
deps =
    pytest
    six
commands =
    pytest

以上是 Plumbum 项目的基本使用文档，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 Plumbum 项目。

plumbum Plumbum: Shell Combinators 项目地址: https://gitcode.com/gh_mirrors/pl/plumbum