Code Monkey home page Code Monkey logo

housing-inventory-tracker's Introduction

Unit Tests CI

housing-inventory-tracker

Creates a line graph showing inventory in a United States county using FIPs codes.

Main Example Graph

How to Generate the Graph

  1. Set your environment variables.

You need a couple environment variables

Key Description Example
raw_historical_county_inventory_data_save_location The file location and name where you want to save the downloaded raw data "./data/raw-data.csv"
formatted_historical_county_inventory_data_location The file location and name where you want to save the formatted data "./data/formatted-data.json"
inventory-tracker-graph-save-location The file location where you want to save the generated graphs "C:\Users\someUser\Desktop\generated-graphs"

Notice that the inventory-tracker-graph-save-location env variable is JUST THE LOCATION. I'll probably change the other two to match that, but haven't done it yet.

  1. Open a terminal in the project root directory.
  2. Run pip install -r requirements.txt. This will install the required dependencies.
  3. Run python driver.py with the appropriate CLI arguments (see below) which will download the raw data, format the raw data, and generate the graph image from the formatted data.

CLI Arguments

There are some required and some optional CLI arguments

flag description example required default additional notes
--counties The fips codes for all the counties you want to generate a line graph for. --counties 39151 39153 yes
--colors The hex color codes you want to use for the lines on the graph. --colors #e01485 #f5a142 no You need to provide the same number of colors as the number of counties you provided.

CLI Examples

Here's a few examples for you to further understand the CLI

python driver.py --counties 39151 --colors #e01485

Graph 1

python driver.py --counties 39151 39153 --colors #e01485 #f5a142

Graph 2

housing-inventory-tracker's People

Contributors

idrumsey avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.