跳转到主要内容

BigBang是一个用于研究协作项目通信数据的工具包。它目前支持分析来自Sourceforge、Mailman、ListServ或.mbox文件的发件列表。

项目描述

BigBang

BigBang是一个用于研究协作项目通信数据的工具包。它目前支持分析来自Sourceforge、Mailman、ListServ(版本16.5和17)、Pipermail(版本0.09)、Hypermail(版本2.4.0)或.mbox文件的发件列表。

BigBang的完整文档可以在ReadTheDocs上找到。

DOI codecov Gitter

安装*

您可以使用Anaconda。这将安装conda包管理器,您可以使用它来完成安装。

安装Anaconda,Python版本为3.*。

如果您选择不使用Anaconda,您可能会遇到Python版本问题。在安装期间将Conda安装目录添加到您的路径中。

您还需要安装Git和Pip(Python3的包管理器)。

运行以下命令

git clone https://github.com/datactive/bigbang.git
cd bigbang
bash conda-setup.sh
python3 setup.py develop --user

此视频教程展示了如何安装BigBang。 BigBang视频教程

使用方法

该存储库的examples/目录中有几个Jupyter笔记本。要打开它们并开始探索,请在该存储库的根目录中运行以下命令

source activate bigbang
ipython notebook examples/

BigBang包含从各种来源收集数据的脚本,例如,要从由Mailman托管的公开发件列表存档中收集数据,请使用

python3 bin/collect_mail.py -u http://mail.python.org/pipermail/scipy-dev/

您还可以将包含多个URL的文件传递给此命令,每个URL占一行。在 examples/ 目录中提供了一个示例。

python3 bin/collect_mail.py -f examples/urls.txt

数据收集完成后,BigBang 提供了支持分析的功能。

您可以在文档中了解更多关于 BigBang 支持的数据源。

开发

单元测试

要运行自动化单元测试,请使用:pytest tests/unit

我们目前的目标是代码覆盖率 60%。在 tests/unit 中添加新的单元测试。单元测试运行速度快,不依赖网络请求。

文档

优先考虑文档字符串,以便可以自动生成基于网络的文档(#412)。您可以遵循Google 风格指南中的文档字符串

格式化

运行 pre-commit install 以在所有 Python 代码文件中自动使用 blackflake8isort 来实现开发者之间的一致格式。我们尽量遵循PEP8 风格指南

社区

如果您对参与 BigBang 的开发感兴趣或需要核心开发团队的支持,请订阅bigbang-dev 邮件列表,并告诉我们您的建议、问题、请求和评论。还有一个开发聊天室可供使用。

为了促进一个开放和欢迎的环境,我们作为贡献者和维护者承诺,让我们的项目和社区成为一个没有骚扰的体验(请参阅我们的行为准则)

故障排除

如果上述安装方法不起作用,您可以尝试使用 Pip 运行安装

git clone https://github.com/datactive/bigbang.git
# optionally create a new virtualenv here
pip3 install -r requirements.txt
python3 setup.py develop --user

出版物

这些学术论文将 BigBang 作为其方法的一部分

许可

麻省理工学院,请参阅LICENSE获取其文本。此许可证可以根据项目治理原则随时更改。

致谢

本项目由

项目详情


下载文件

下载您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分发

bigbang-py-0.4.4.tar.gz (22.7 KB 查看哈希值

上传时间:

由支持