Skip to content
This repository was archived by the owner on May 15, 2025. It is now read-only.

Development environment setup

Jump to bottom
Adrian Edwards edited this page Jun 11, 2023 · 13 revisions

To get started helping out, you need to set up the vaccine-feed-ingest cli. From there, you'll be able to start writing scraper pipeline stages. To date, we've built pipeline stages in bash and python, but aren't dogmatic about it.

Quick Setup on macOS

  1. Clone the repository:

    git clone https://github.com/rit-hc-website/data-ingest

  2. Navigate to your git checkout

    cd vaccine-feed-ingest

  3. Run the setup script:

    bash ./setup.sh

  4. Test your installation!

    poetry run vaccine-feed-ingest --help

  5. Head on over to running vaccine-feed-ingest.

Advanced / Manual setup

If you'd prefer to run commands by hand or are running Linux (or WSL), check out the advanced setup instructions

Contributing

  1. Find an issue you'd like to help out with
  2. Set up a development environment
  3. Read up on how our pipeline works
  4. Run the pipeline locally

Shared tooling

Some pre-built tools to help fetch or parse common data types

  1. Parse .json to .ndjson
Clone this wiki locally