Update Readme

README.md

@@ -1,14 +1,21 @@
-# Immunization Records Pipeline
-A data pipeline that minimizes manual effort when extracting immunization records from the Minnesota Department of Health, transforming them, and loading them into the student information system, Infinite Campus.
+<h1 align="center">🩺⚙️ Immunization Records Pipeline 🩺⚙️</h1>
+
+<h4 align="center">A data pipeline that minimizes manual effort when extracting immunization records from the Minnesota Department of Health, transforming them, and loading them into the student information system, Infinite Campus.</h4>
 
 ## Running the AISR to Infinite Campus CSV Transformation
-Instructions for MacOS users:
+1. Make sure you have Python 3 installed on your computer.
+1. Open your terminal and paste the command below:
+
+   ```bash
+   pip install minnesota-immunization-data-pipeline
+
+   # If you get an error about 'pip not found', just replace pip with pip3.
+   ```
+1. Then you can run the project with `minnesota-immunization-data-pipeline --input_folder "<input_folder_path>" --output_folder "<output_folder_path>" --log_folder <log_folder_path>`
+
+## Developer Setup
+Developer setup is easy with Dev Containers!
 1. [Download the code locally](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
-1. Open terminal and cd into the newly downloaded code
-1. Run `./setup_and_run_mac.sh`
-
-You can also run the script without the folder popup windows:
-1. [Install Poetry](https://python-poetry.org/docs/)
-1. From the directory that that the project is installed, run `cd immunization-records-project/data-pipeline`
-1. Then run `poetry install --only main` to get the project dependencies. You only need to run this once.
-1. Then you can run the project with `poetry run python data_pipeline --input_folder "<input_folder_path>" --output_folder "<output_folder_path>" --log_folder <log_folder_path>`
+1. Ensure [VS Code](https://code.visualstudio.com/) is installed
+1. Follow the tutorial [here](https://code.visualstudio.com/docs/devcontainers/tutorial) to set up Dev Containers.
+1. Run the command `Dev Containers: Reopen in Container`

data-pipeline/pyproject.toml

@@ -1,9 +1,9 @@
 [tool.poetry]
 name = "minnesota-immunization-data-pipeline"
-version = "0.2.1"
+version = "0.2.2"
 description = "A data pipeline that minimizes manual effort when extracting immunization records from the Minnesota Department of Health, transforming them, and loading them into the student information system, Infinite Campus."
 authors = ["Dillon O'Leary <[email protected]>"]
-readme = "README.md"
+readme = "../README.md"
 license = "GPL-3.0-only"
 repository = "https://github.com/DillonOLeary/immunization-records-pipeline"
 keywords = ["etl", "poetry", "immunization", "civic tech"]