Skip to content

Tool for grabbing and collating comments on regulations from regulations.gov

Notifications You must be signed in to change notification settings

scottymeyers/co-regulations-gov

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

co-regulations-gov

Installation

Download code and install dependencies

$ git clone git@github.com:coforma/co-regulations-gov.git
$ cd co-regulations-gov
$ yarn install

API Key & Environment Variables

  1. Go to https://open.gsa.gov/api/regulationsgov/ and request an API KEY. The API KEY should arrive by email within a few minutes.

  2. In ./workspaces/api make a copy of .env-example as .env and add your API KEY.

  3. In ./workspaces/ui, make a copy of .env-example as .env

Web Application Usage

You'll need the parent Document ID which may be obtained by navigating to that particular Document on regulations.gov.

Then, in the project root, run:

$ yarn start

You can now use the interface at: http://localhost:3000/

Try NHTSA-2021-0001 to test.

CLI

Running the following command in the project root:

$  yarn cli --documentId={DOCUMENT_ID}

Will generate results to output/output-{DOCUMENT_ID}.csv & output-{DOCUMENT_ID}.json.

Limitations

Though the script does account for rate limits, it doesn't do so exhaustively. The API's current rate limit is 500 per hour. Consequently, if there are over ~475 comments, it will likely begin to fail at some point.

Feedback

We welcome any/all feedback/comments, including the creation of Issues and/or Pull requests to this repository.

Please direct any non-code feedback to: https://coforma.io/connect/

About

Tool for grabbing and collating comments on regulations from regulations.gov

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 93.7%
  • JavaScript 3.3%
  • HTML 2.9%
  • Shell 0.1%