量化公共空间

该项目旨在量化公共空间的规模和多样性——公开授权或公共领域的作品集。

该项目目前正在作为谷歌代码夏令营（GSoC）进行项目。目标是增加数据收集和报告生成的自动化因此，我们量化公地的报告永远不会超过3个月日期。为了准备此重构，以前的工作被转移到自动化前/.

代码_ OF_ CONDUCT.md:

Creative Commons团队致力于培养一个受欢迎的社区。此项目和所有其他Creative Commons开放源码项目均受管理由我们的行为准则.请报告不合格行为conduct@creativecommons.org根据我们的报告准则.

请参阅贡献.md.

此存储库使用pipenv公司管理所需的Python模块：

1. 安装管道nv:
   • Linux：安装Pipenv
   • macOS：
     1. 安装自制软件
     2. 安装pipenv：

        brew安装pipenv

   • 窗户：安装Pipenv
2. 使用创建Python虚拟环境并安装前提条件pipenv公司:

   pipenv同步--开发

要成功运行需要客户端凭据的脚本，您需要遵循以下步骤：

1. 复制环境示例脚本目录中的文件.env（英语）:

   cp env.example.env

2. 取消注释中的变量.env（英语）文件并根据需要分配值。请参阅源.md关于如何获取凭据：

   GOOGLE_API_KEYS=你的_API_keyPSE_KEY=您的密钥

3. 将更改保存到.env（英语）文件。
4. 现在您应该能够运行需要客户端凭据的脚本没有任何问题。

静态分析工具确保代码库遵循一致的格式和风格指南，增强可读性和可维护性。另请参阅GitHub操作，如下。

预提交允许使用静态分析工具(黑色,薄片8,监控程序等）手动运行或每次提交时运行：

1. （通过完成Create the Python虚拟环境来安装Pre-commit和安装必备组件，如上）
2. 手动安装或运行
   • 安装git钩子脚本，以便在每次提交时自动执行

     pipenv运行提交前安装

   • 提交前手动运行：

     pipenv运行预提交运行-a

3. （可选）查看配置文件：.预提交配置.yaml

这个开发/工具.shhelper脚本运行静态分析工具(黑色,薄片8、和监控程序):

./dev/tools.sh

它还可以接受命令行参数来指定特定文件或要检查的目录：

./dev/tools.sh路径/TO/MY/FILE。上一年度

• Python指南-Creative Commons开源
• 黑色:毫不妥协的Python代码格式化程序
• 薄片8:将pep8、pyflakes、mccabe、，和第三方插件来检查一些python代码的风格和质量。
• 监控程序:用于对导入进行排序的Python实用程序/库
  • （它不导入任何库，只对它们进行排序和格式化。）
• ppypa/pipenv:人类Python开发工作流。
• 预先提交:管理和维护框架多语言预提交挂钩。
• 登录中:利用内置的Python日志模块从共享模块实现灵活的日志系统。

这个.github/workflows/python_static_analysis.ymlGitHub Actions工作流执行静态分析(黑色,薄片8、和监控程序)提交的更改。当您将更改推送到主分支或打开拉请求。

请访问源.md文件。

有关过去努力的信息，请参阅历史.md.

许可证：此存储库中的代码是根据外籍人士/麻省理工学院许可证。

此存储库中的数据专用于CC0 1.0通用（CC0 1.0）公共域专用.

项目中的文档根据知识共享归因4.0国际许可.