joblib 的主页以及用户文档位于:
https://joblib.readthedocs.io
要使用 git 获取最新代码,只需键入:
git 克隆 https://github.com/joblib/joblib.git
如果您没有安装 git,可以下载最新代码的 zip:https://github.com/joblib/joblib/archive/refs/heads/main.zip
您可以使用 pip 安装 joblib:
pip 安装 joblib
从任何目录或:
python setup.py 安装
从源目录。
要为 joblib 做出贡献,首先在 github 上创建一个帐户。完成此操作后,分叉 joblib 存储库以拥有您自己的存储库,并在您想要工作的计算机上使用“git clone”克隆它。在克隆中进行更改,将它们推送到您的 github 帐户,在多台计算机上测试它们,当您对它们感到满意时,向主存储库发送拉取请求。
要运行测试套件,您需要 pytest(版本 >= 3)和覆盖率模块。使用以下命令运行测试套件:
pytest作业库
从项目的根开始。
要构建文档,您需要安装 sphinx (>=1.4) 和一些依赖项:
pip install -U -r .readthedocs-requirements.txt
然后可以使用以下命令构建文档:
制作文档
html 文档位于doc/_build/html
目录中。
要创建源 tarball(例如用于打包或分发),请运行以下命令:
python setup.py sdist
tarball 将在 dist 目录中创建。此命令将编译文档,并且可以安装生成的 tarball,除了 Python 标准库之外没有额外的依赖项。您将需要 setuptool 和 sphinx。
此命令仅由项目经理运行,用于发布版本并上传到 PyPI:
python setup.py sdist bdist_wheel 缠绕上传距离/*
请注意,文档应该在每次 git 推送时自动更新。如果不是这种情况,请尝试在本地构建文档并解决任何文档构建错误(特别是在运行示例时)。
更改列在 CHANGES.rst 文件中。它们必须手动更新,但是可以使用以下 git 命令来生成这些行:
git log --abbrev-commit --date=short --no-merges --sparse