# ramile

**Repository Path**: zhu_yongbo/ramile

## Basic Information

- **Project Name**: ramile
- **Description**: ramile汉化版
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-02-17
- **Last Updated**: 2023-02-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Ramile

>  快速开始：
>
> ```shell
> python ramile-cli.py whatcanido
> ```
>
> - 快速查看支持的语言列表
>
> ```shell
>  python ramile-cli.py extract <path to your project root>
> ```
>
> - 运行如上命令即可在项目根目录生成名为extracted_code.docx的文件！

原作者：![image-20230217142207714](https://gitee.com/zhu_yongbo/imgs/raw/master/image-20230217142207714.png) github原链接：https://github.com/luxel/ramile



Ramile是一个方便的工具，用于自动从给定的项目/文件夹中提取3000行源代码，这是中国软件版权申请过程的要求。Ramile的目标是为每次软件版权提交准备60页源代码节省0.5~1小时的时间_
目前，Ramile具有以下功能：

- 自动提取源代码并生成包含3000行的docx文件。（不过，您必须手动删除docx的最后几页，使其正好为60页）
- 支持大多数commmon前端项目：android/ios/web/Wechat迷你程序等
- 可配置。只需在项目根文件夹下放置一个`.ramileconfig.json`。（有关详细信息，请参阅“配置”部分）

在python 3.6.1下测试。

## 安装

现在我们只能从源代码运行Ramile。将来它可能会上传到pypi。
要运行Ramile源代码，请克隆存储库并安装依赖项：“pip install-r requirements.txt”。

国内可以使用镜像`pip install -i https://pypi.mirrors.ustc.edu.cn/simple/ -r requirements.txt`

## 基本用途

从源代码运行：

```
python ramile-cli.py extract <path to your project root>
```

提取完成后，将在项目根目录下生成名为“extracted_code.docx”的文件，其中包含3000行代码。您只需打开它并删除不必要的页面，使文档精确到60页。

如果你想严格遵守 [regulation](./著作权法.md#第十条-软件的鉴别材料包括程序和文档的鉴别材料), 您可以通过将“Inf”附加到命令行来提取所有行：

```
python ramile-cli.py extract <path to your project root> Inf
```

然后你只需要打开它，保留前30页和后30页，然后删除所有中间页。

## 配置

Ramile自动从项目根目录加载配置文件“.ramileconfig.json”（如果它退出）。文件应为json格式。可能的配置项目如下：

| Key              | 描述                                                         | 默认 | 例如             |
| :--------------- | :----------------------------------------------------------- | :--- | :--------------- |
| ignore           | 设置Ramile要忽略的目录/文件。“忽略”路径应该是source_root下的子目录/文件。以任何一个“忽略”项开头的任何目录/文件都将被忽略。不支持通配符。 | []   | ['Pods', 'libs'] |
| source_root      | 覆盖源代码的根目录，以避免项目根目录中的Ramile进程。         | ''   | 'app'            |
| filters          | 设置文件扩展名的独占筛选器（这意味着不会处理所有其他扩展名）。默认情况下，将处理所有文件。 | []   | ['.js', '.vue']  |
| lines_to_extract | 设置要提取的总行                                             | 3000 | 3000             |

## 支持的语言

| 语言        | 扩展名                |
| :---------- | :-------------------- |
| JavaScript  | .js, .jsx, .vue, .wpy |
| Java        | .java                 |
| PHP         | .php                  |
| HTML        | .html, .htm           |
| CSS         | .css, .less, .sass    |
| Swift       | .swift                |
| Objective-C | .m                    |

## 测试：

```shell
cd tests
pytest
```