From 9cd52f8e7498cbd228a8c3eec60a09692efb8d74 Mon Sep 17 00:00:00 2001 From: bhavik Date: Thu, 1 Feb 2024 14:34:27 +0530 Subject: [PATCH] yes --- scripts/README.md | 61 +---------------------------------------------- 1 file changed, 1 insertion(+), 60 deletions(-) diff --git a/scripts/README.md b/scripts/README.md index 2e926a37..98c515b2 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -13,63 +13,4 @@ scripts │ └───validate # validate package format.py - links.py -``` - -## Install dependencies - -You must have [python](https://www.python.org/) installed to use these scripts. - -it is also necessary to install the validation package dependencies, use [pip package manager](https://pypi.org/project/pip/) for this: - -```bash -$ python -m pip install -r scripts/requirements.txt -``` - -## Run validations - -To run format validation on the `README.md` file, being in the root directory of public-apis, run: - -```bash -$ python scripts/validate/format.py README.md -``` - -To run link validation on the `README.md` file, being in the root directory of public-apis, run: - -```bash -$ python scripts/validate/links.py README.md -``` - -As there are many links to check, this process can take some time. If your goal is not to check if the links are working, you can only check for duplicate links. Run: - -```bash -$ python scripts/validate/links.py README.md -odlc -``` - -*`-odlc` is an abbreviation of `--only_duplicate_links_checker`* - -## 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" -``` + links \ No newline at end of file