Cleanup in prep for Sprint 2

README.md

@@ -1,5 +1,4 @@
 # Route Rangers
-
 The Route Rangers project seeks to provide an innovative solution to bridge the gap between policy makers and the public across the US, enabling urban transit policy makers to utilize data analytics while incorporating public feedback in transit planning. The purpose of our planning tool is to revitalize public interest and participation in transit, driving increased ridership and creating more efficient networks that meet urban community needs.
 
 The Route Rangers project consists of two main components:

backend/ingestion/extract_census_data.py

@@ -1 +0,0 @@
-

backend/ingestion/extract_nyt_data.py

@@ -1,19 +1,23 @@
-import os 
+import os
 from typing import List
 import requests
 from lxml.html import html_parser
 import json
 
-#def create_nyt_client()
+# def create_nyt_client()
 
-def extract_table_mta_json(end_point:str,api_key = None)-> str:
+
+def extract_table_mta_json(end_point: str, api_key=None) -> str:
     """
-    Extracts the json response from a API request to the NYC Data portal 
+    Extracts the json response from a API request to the NYC Data portal
     """
     resp = requests.get(end_point)
     resp_json = json.loads(resp.text)
     return resp_json
 
+
 if __name__ == "__main__":
-    resp = extract_table_mta_json(end_point="https://data.ny.gov/resource/uu7b-3kff.json")
-    print(resp)
+    resp = extract_table_mta_json(
+        end_point="https://data.ny.gov/resource/uu7b-3kff.json"
+    )
+    print(resp)

backend/tests/test_example.py

@@ -1,2 +1,5 @@
+import pytest
+
+
 def test_framework():
     assert (1 + 1) == 2

documentation/datamodel.md

@@ -1,8 +1,6 @@
 # Datamodel prototype 
 
-The datamodel prototype can be found in the following link: 
-
-https://lucid.app/lucidchart/acedfe58-359d-42ba-8dc9-b9421517ead9/edit?invitationId=inv_a9fee266-b5b0-4243-bfa8-ccf7f44afd22&referringApp=slack&page=0_0#
+The datamodel prototype can be found in the following [lucidchart link](https://lucid.app/lucidchart/acedfe58-359d-42ba-8dc9-b9421517ead9/edit?invitationId=inv_a9fee266-b5b0-4243-bfa8-ccf7f44afd22&referringApp=slack&page=0_0#)
 
 In the diagram, each table has three features, the first column, identifies if a variable is categorized as Primary Key, Foreign Key or none, the second column represent the variable in the table –and therefore one column on the database–, and the third column represents the datatype.
 

documentation/design.md

@@ -1,3 +1,3 @@
 # Prototypes
 
-Prototype can be found in Figma
+Prototype can be found in [this Figma](https://www.figma.com/file/bXKQi5P1RpGKSb1Ao6w0V5/Community-Transit-Tool?type=design&node-id=90-70&mode=design&t=Hq9pcP90gVrj9UDK-0)