LAUSD COVID-19 Dashboard Standalone Data Pipeline

Standalone version of the data pipelines used to retrieve data from the Los Angeles Unified School District (LAUSD) COVID-19 Dashboard, and transform it into CSVs for use in other projects.
Explore the docs »

Report Bug | Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

This is a standalone version of the data pipelines used to retrieve data from the Los Angeles Unified School District (LAUSD) COVID-19 Dashboard, and transform it into CSVs for use in other projects.

An example of how the data generated by this tool is used in the real-world: @herf's LAUSD COVID-19 Dashboard

Built With

• Python 3
• jq
• pandas

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Python 3 binaries, if missing from your workstation, can be downloaded here. Note: you're better off setting up virtual environments (e.g. pyenv)
• Python dependencies are listed in the requirements.txt file. Once you clone the repo to your local workstation, you can also cd into the local folder and run in your terminal:

  cat requirements.txt

Installation

1. Clone the repo

   git clone https://github.com/jorge-caballero/standalone-etl-LAUSD.git

2. Install dependencies

   Makefile init

Usage

This is a standalone app with a command-line interface. To get started, simply run the following command:

python main.py --help

Here's an example of the command-line options (as of the initial release) []

For an example of how the data generated by this tool is used in the real-world, check out @herf's LAUSD COVID-19 Dashboard

Roadmap

• See this project for a list of proposed and planned updates
• Check out issues for a list of known issues (and pending fixes)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the AGPL-3.0 License. See LICENSE for more information.

Contact

Jorge A. Caballero, MD - @DataDrivenMD - brays[dot]quavers[dot]0t[at]icloud[dot]com

Project Link: https://github.com/jorge-caballero/standalone-etl-LAUSD

Acknowledgements

• @herf for putting the data into good use. Make sure to check out his L.A. COVID repo, which includes more sources of COVID-19 data for the greater Los Angeles metro area
• @othneildrew for the awesome README template
• Parents Supporting Teachers for using the data to advocate on behalf of students and teachers