connPFM

一个模板库，用于创建新的存储库。

安装

    git clone https://github.com/SPiN-Lab/connPFM.git
    cd connPFM
    pip3 install -e .[all]

说明

1. 在整个存储库中将connPFM替换为新存储库名称。
2. 在Zenodo上启用GitHub存储库。
3. 在CircleCI上设置GitHub存储库。
4. 在ReadTheDocs上设置GitHub存储库。
5. 在GitHub上发布第一个版本。
   • PyPi部署操作将失败。
6. 部署到PyPi（以下说明基于此页面）
   1. pip install twine
   2. python setup.py sdist bdist_wheel
   3. 上传到TestPyPi
      1. twine upload --repository-url https://test.pypi.org/legacy/ dist/*
      2. 输入TestPyPi用户名
      3. 输入TestPyPi密码
   4. 如果TestPyPi成功，则上传到PyPi
      1. twine upload dist/*
      2. 输入PyPi用户名
      3. 输入PyPi密码
   5. 现在未来的GitHub发布应该通过操作部署到PyPi，不会出现任何问题。
7. 由于现在有一个真正的发布，请现在更新Zenodo徽章。
   • 您必须在将PyPi部署之后执行此操作，因为任何在第一个发布之后的新提交都将更改由versioneer管理的版本字符串。
8. 将所有重要的CI步骤添加到main分支的保护规则中。
9. 为以下添加集成
   • AllContributors
   • 欢迎
   • CodeCov
   • circleci-artifacts-redirector
   • 发布草稿？不确定这个操作是否可以适当地替代集成。

关于此配置的信息

通过CircleCI进行持续集成

默认配置使用CircleCI和make来管理测试。测试运行后，代码覆盖率信息将推送到CodeCov。CircleCI也将构建文档作为CI的一部分，并且需要一个工件重定向器（circleci-artifacts-redirector）来轻松地查看每个PR的渲染文档。

使用versioneer进行版本控制

Versioneer用于自动跟踪和更新版本字符串。

使用flake8、black和isort进行代码检查

flake8、black和isort用于管理代码风格。

使用duecredit进行参考文献管理

duecredit用于为代码库构建参考文献列表。duecredit作为必需依赖项包含在内。

使用Sphinx和ReadTheDocs进行文档编写

包文档是用Sphinx构建的，我们假设文档将由ReadTheDocs托管。

部署到PyPi

该包设计为可以通过pip安装并托管在PyPi上。新版本将通过GitHub操作自动推送到PyPi。