openlawnz-parser

General requirements

Yarn
Rename .env.sample to .env.env (e.g. .env.local) and fill in with PostgreSQL details.
```
cp .env.sample .env
```
Docker

env

Where you see the env option in a command, it will look for the corresponding ".env.env" file in the root of the project. You could have .env.local and .env.dev, for example.

Installing

# Do not run npm install
yarn install

Database Setup

We use Docker to download and provision the OpenLaw NZ database. Simply run docker.sh - you will need access to the devops repo - ask in Slack for that, and then update your .env file.

There are 2 schemas:

pipeline_cases: this is populated by running the pipeline and is not affected by the parsers
cases: this is populated and mutated by running the parsers

And check if it has correctly restored SQL dump file.

# See all containers available
docker ps -a
# Open psql cli and run docker execution with details
docker exec -it <container-name/id> psql -U <username> -d <db-name>
# If you ran the script from openlawnz-orchestration
docker exec -it openlawnz-postgres psql -U postgres -d openlawnz_db

To see tables

# In psql cli
\dt *.*

To use docker-compose, you may find this page Getting started with Docker useful.

Process

Each time a full run of the parsers is started the cases database is emptied and filled with the pipeline_cases data before running through each parser
Each script can be run individually

Running example

cd parser
node parseCaseToCase.js --env=<env>

To run all the scripts

node index.js --env=<env>

Testing

When you make a pull request, yarn test will automatically start via Github Action. To run locally, use yarn test in your local terminal.

For OpenLaw NZ volunteers

Ask for a copy of the OpenLaw NZ DB in the Slack channel
- If you're interested in volunteering please get in touch!

NOTICE

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

kaliumxyz / openlawnz-parsers