Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cityssm/wsib-clearance-check-csv-cli
A command line tool to retrieve clearance certificates from the WSIB website.
https://github.com/cityssm/wsib-clearance-check-csv-cli
clearance-certificate-status cli command-line-tool csv hacktoberfest insurance ontario web-scraping workplace wsib
Last synced: 27 days ago
JSON representation
A command line tool to retrieve clearance certificates from the WSIB website.
- Host: GitHub
- URL: https://github.com/cityssm/wsib-clearance-check-csv-cli
- Owner: cityssm
- License: mit
- Created: 2021-08-31T19:15:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T08:16:50.000Z (over 1 year ago)
- Last Synced: 2023-07-31T09:29:01.032Z (over 1 year ago)
- Topics: clearance-certificate-status, cli, command-line-tool, csv, hacktoberfest, insurance, ontario, web-scraping, workplace, wsib
- Language: JavaScript
- Homepage:
- Size: 729 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wsib-clearance-check-csv-cli
[](https://www.codacy.com/gh/cityssm/wsib-clearance-check-csv-cli/dashboard?utm_source=github.com&utm_medium=referral&utm_content=cityssm/wsib-clearance-check-csv-cli&utm_campaign=Badge_Grade)
[](https://codeclimate.com/github/cityssm/wsib-clearance-check-csv-cli/maintainability)
[](https://github.com/cityssm/wsib-clearance-check-csv-cli/actions/workflows/test.yml)
[](https://app.snyk.io/org/cityssm/project/9605d6ee-84f6-41f6-a0c4-b5daa96160ae)
A command line tool to simplify retrieving clearance certificates from the WSIB website.
**Looking to tie WSIB clearance certificate lookups into your own project?**
[Check out the wsib-clearance-check project.](https://github.com/cityssm/wsib-clearance-check)
## Usage
```sh
node lookup
-input [inputFile.txt | inputFile.csv | inputFile.xlsx]
-output [outputFile.csv]
-error [errorFile.csv]
[-real]
```
### Parameters
`-input [inputFile.txt | inputFile.csv | inputFile.xlsx]` or
`-i [inputFile.txt | inputFile.csv | inputFile.xlsx]`
- Specifies the path to the file that should be parsed.
- The file can be either
a [simple text file](test/input.txt) with one WSIB Account Number on each line,
a [CSV file](test/input.csv) with the WSIB Account Number in the first column,
or an [XLSX file](test/input.xlsx) with the WSIB Account Number in the first column of the first sheet.
`-output [outputFile.csv]` or
`-o [outputFile.csv]`
- Specifies the name of the CSV file that should contain
successfully retrieved clearance certificates.
- This file is only written if there are records to write.
- The output file includes the following fields.
[See a sample output file.](test/output.csv)
- accountNumber
- contractorLegalTradeName
- contractorAddress
- clearanceCertificateNumber
- validityPeriodStart
- validityPeriodEnd
- principalLegalTradeName
- principalAddress
- certificateURL
`-error [errorFile.csv]` or
`-e [errorFile.csv]`
- Specifies the name of the CSV file that should contain error messages.
- This file is only written if there are errors to write.
- The error file includes the following fields.
[See a sample error file.](test/error.csv)
- accountNumber
- error
- errorURL
`-real` or
`-r`
- Runs in "real browser" mode, as opposed to "headless browser" mode.
- Useful for debugging, but not recommended for production use.
## Setup
Ensure system has [NodeJS](https://nodejs.org/) 14 or better installed.
Download the latest code from this repository. This can be done from this website,
from a `git` command line, or using [GitHub Desktop](https://desktop.github.com/).
Save to the folder of your choice.
Install the dependencies.
```sh
npm install
```
See if it works.
```sh
npm test
```
## 🙏 Thanks
This project was developed in collaboration with [FRANCOachat](https://ceafrancoachat.ca/),
an organization that provides procurement services to several Ontario school boards.