用于Mozilla实验分析的库
项目描述
Firefox 实验分析

《mozanalysis》Python 库是一个用于在 Mozilla 标准化实验分析的库,旨在生成由数据科学家编辑的决策报告模板。
文档
在线文档可在https://mozilla.github.io/mozanalysis/找到
从 PyPI 安装
- 要从 PyPI 安装此软件包,请运行以下命令:
pip install mozanalysis
本地安装
依赖关系
依赖关系在 requirements.txt
和 requirements-dev.txt
文件中指定,分别用于测试和开发。要创建虚拟环境并设置软件包,请执行以下命令,将 requirements.txt
替换为 requirements-dev.txt
,如果您计划为软件包做出贡献。
# Create and activate a python virtual environment.
python3 -m venv venv/
source venv/bin/activate
pip install -r requirements.txt
pip install -e . --no-dependencies
开发
使用 Ruff 进行代码风格检查和格式化。
当添加新依赖关系时,将它们添加到 pyproject.toml
的 dependencies
列表中。然后使用脚本 script/update_deps
生成更新的需求文件。此脚本中调用 pip-compile
,它使用指定的依赖关系来创建 requirements.txt
和 requirements-dev.txt
文件。最后,您需要通过运行 pip install -r requirements-dev.txt
来更新虚拟环境中的需求。
本地测试
使用 pytest
从软件包文件结构的根目录运行命令行中的 pytest
。
使用 tox
tox 包含在开发依赖关系中。如果您想使用 tox 运行,请按照上述方法在 requirements-dev.txt
中安装开发依赖关系。
您可以将标志传递给 tox 以限制测试的不同环境或运行的测试。位于 --
之后或位置参数后的选项将被转发到 pytest。
例如,您可以运行:
-
tox -e lint
进行代码风格检查 -
tox -e py310 -- -k utils
仅在 Python 3.10 上运行名称中包含 "utils" 的测试 -
tox tests/test_utils.py
运行特定文件中的测试
使用 CircleCI 工具
要本地测试/调试此软件包,您可以通过安装 CircleCI 本地 CLI 并调用,来运行 CircleCI 为持续集成运行的作业
circleci build --job py310
有关其他配置的作业名称(用于在不同 Python 版本上运行测试),请参阅.circleci/config.yml。
部署新版本
通过标记基于 CalVer 的 Git 标签来发布 mozanalysis,其模式如下:
YYYY.M.MINOR
其中 YYYY 是四位数的年份,M 是单个数字的月份,MINOR 是单个数字的零基计数器,它与发布日期无关。有效的版本号如下:
2017.10.0
2018.1.0
2018.12.12
一旦将(签名)Git 标签推送到主 GitHub 存储库,使用 git push origin --tags,在测试通过后,Circle CI 将自动构建并将版本推送到 PyPI。
项目详情
mozanalysis-2024.9.5.tar.gz 的散列值
算法 | 散列摘要 | |
---|---|---|
SHA256 | c307562eff90c02aadbc090354792e54bb803a1fdd0614fd84b68af9be790bc3 |
|
MD5 | 0753850c2af2705ecb8d67b5812a02b9 |
|
BLAKE2b-256 | 124b13e18769fbbe5bb96b66baf8f77f23ac889239d349728ea56196c2a3786d |