浏览代码

Create README.md to scripts directory

pull/3011/head
Matheus Felipe 2 年前
父节点
当前提交
08ba4e6458
找不到此签名对应的密钥 GPG 密钥 ID: AA785C523274872F
共有 1 个文件被更改,包括 45 次插入0 次删除
  1. +45
    -0
      scripts/README.md

+ 45
- 0
scripts/README.md 查看文件

@@ -0,0 +1,45 @@
# Public APIs Scripts

This directory contains all validation and testing scripts used by Public APIs.

```bash
scripts
│ github_pull_request.sh # used to validate changes of a pull request
│ requirements.txt # contains dependencies of validate package
├───tests # contains all unit tests from the validate package
│ test_validate_format.py
│ test_validate_links.py
└───validate # validate package
format.py
links.py
```

## Running Tests

To run all tests it is necessary to change to the scripts directory:

```bash
$ cd scripts
```

then run:

```bash
$ python -m unittest discover tests/ --verbose
```

To run only the format tests, run:

```bash
$ python -m unittest discover tests/ --verbose --pattern "test_validate_format.py"
```

To run only the links tests, run:

```bash
$ python -m unittest discover tests/ --verbose --pattern "test_validate_links.py"
```

*Note that it is necessary to have [python](https://www.python.org/) installed.*

正在加载...
取消
保存