Development environment setup

To get started helping out, you need to set up the event-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/CampusPulse/data-ingest

2. Navigate to your git checkout

   cd event-feed-ingest

3. Run the setup script:

   bash ./setup.sh

4. Test your installation!

   poetry run event-feed-ingest --help

5. Head on over to running event-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