3pp-mirror/public-apis
1
0
Fork 0
mirror of https://github.com/public-apis/public-apis.git synced 2025-06-09 14:21:49 +02:00
Code Issues Projects Releases Packages Wiki Activity

Create install dependencies section

Browse source
This commit is contained in:
Matheus Felipe 2022-01-17 20:25:30 -03:00
parent 1c3e4eba37
commit fb70084377
No known key found for this signature in database
GPG key ID: AA785C523274872F
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
scripts/README.md
View file

@ -16,6 +16,16 @@ scripts
links.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 ## Run validations
To run format validation on the `README.md` file, being in the root directory of public-apis, run: To run format validation on the `README.md` file, being in the root directory of public-apis, run:
@ -55,5 +65,3 @@ To run only the links tests, run:
```bash ```bash
$ python -m unittest discover tests/ --verbose --pattern "test_validate_links.py" $ python -m unittest discover tests/ --verbose --pattern "test_validate_links.py"
``` ```
*Note that it is necessary to have [python](https://www.python.org/) installed.*