开源项目 Ramile 指南及常见问题解答

开源项目 Ramile 指南及常见问题解答

ramile China software copyright extraction tool - 中国软件著作权代码自动提取工具 项目地址: https://gitcode.com/gh_mirrors/ra/ramile

项目基础介绍

Ramile 是一款专门为中国软件著作权申请设计的开源工具，它自动化抽取给定项目或文件夹中的3000行源代码，以满足中国软件著作权提交过程中对60页源代码文档的需求。这款工具支持多种前端项目，包括但不限于Android、iOS、Web和微信小程序等。Ramile基于Python开发，当前版本兼容Python 3.6.1及以上。配置灵活，通过在项目根目录放置ramileconfig.json文件即可定制化操作。

新手注意事项及解决步骤

问题1：环境配置问题

注意点：确保Python环境正确安装，并且版本符合要求（至少Python 3.6.1）。 解决步骤：

1. 首先，检查你的系统是否已安装Python，打开命令行输入 python --version 或 python3 --version。
2. 若未安装Python，访问Python官网下载并安装相应版本，记得勾选添加至PATH选项。
3. 安装完成后，使用pip安装项目依赖：pip install -r requirements.txt。如果在中国地区遇到下载慢的问题，可以使用国内镜像如阿里云：pip install -i https://mirrors.aliyun.com/pypi/simple/ -r requirements.txt。

问题2：代码提取不完整或错误

注意点：确保项目的结构清晰，且ramileconfig.json配置正确。 解决步骤：

1. 创建或检查ramileconfig.json文件位于项目根目录下，确认其内容正确无误。例如设置忽略特定目录或文件以防被错误提取。
2. 如果有指定路径的文件未能正确提取，请检查配置文件中是否有误或使用了不当的通配符。
3. 运行命令时，确保指定了正确的项目路径：python ramile-cli.py extract <project_path>。

问题3：生成的文档不符合60页要求

注意点：默认生成的docx文件可能超过60页，需手动调整。 解决步骤：

1. 完成代码提取后，会生成一个名为extracted_code.docx的文档。
2. 打开该文档，手动删除最后几页，以确保文档正好是60页。如果要严格遵循规范，可以尝试使用命令参数Inf提取所有行，然后保留文档的前30页和后30页，删除中间部分。
3. 保存修改后的文档，完成软件著作权申请所需的准备。

通过以上步骤，新用户可以有效地避免常见问题，顺利使用Ramile工具进行源代码的自动提取，简化申请过程。

ramile China software copyright extraction tool - 中国软件著作权代码自动提取工具 项目地址: https://gitcode.com/gh_mirrors/ra/ramile