tox-pipenv 项目使用教程
tox-pipenvA pipenv plugin for Tox项目地址:https://gitcode.com/gh_mirrors/to/tox-pipenv
1. 项目的目录结构及介绍
tox-pipenv/
├── docs/
│ ├── conf.py
│ ├── index.rst
│ └── ...
├── src/
│ └── tox_pipenv/
│ ├── __init__.py
│ ├── plugin.py
│ └── ...
├── tests/
│ ├── __init__.py
│ ├── test_plugin.py
│ └── ...
├── .gitignore
├── LICENSE
├── README.md
├── setup.cfg
├── setup.py
└── tox.ini
- docs/: 包含项目的文档文件,如配置文件
conf.py
和文档索引index.rst
。 - src/tox_pipenv/: 包含项目的主要源代码,如插件文件
plugin.py
。 - tests/: 包含项目的测试文件,如
test_plugin.py
。 - .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
- LICENSE: 项目的开源许可证。
- README.md: 项目的介绍和使用说明。
- setup.cfg: 项目的配置文件,用于打包和分发。
- setup.py: 项目的安装脚本。
- tox.ini: 项目的 tox 配置文件。
2. 项目的启动文件介绍
项目的启动文件主要是 setup.py
,它负责项目的安装和分发。通过运行以下命令可以安装项目:
pip install .
3. 项目的配置文件介绍
tox.ini
tox.ini
是 tox 的配置文件,用于配置测试环境和测试命令。以下是一个简单的示例:
[tox]
envlist = py27, py36
[testenv]
deps = pytest
pytest-mock
commands = python -m pytest test/
- [tox]: 配置测试环境列表,如
py27
和py36
。 - [testenv]: 配置每个测试环境的依赖和命令,如使用
pytest
执行测试。
setup.cfg
setup.cfg
是项目的配置文件,用于打包和分发。以下是一个简单的示例:
[metadata]
name = tox-pipenv
version = 1.2.0
description = A tox plugin that uses Pipenv
author = Anthony Shaw
author_email = anthonyshaw@apache.org
license = MIT
[options]
packages = find:
install_requires =
tox>=3.0
pipenv
[options.entry_points]
tox =
tox_pipenv = tox_pipenv.plugin:ToxPipenv
- [metadata]: 配置项目的元数据,如名称、版本、描述、作者和许可证。
- [options]: 配置项目的包和依赖。
- [options.entry_points]: 配置项目的入口点。
通过以上配置,可以确保项目在不同的 Python 版本和环境中正确安装和运行。
tox-pipenvA pipenv plugin for Tox项目地址:https://gitcode.com/gh_mirrors/to/tox-pipenv