bridges.data_src_dependent.data_source Namespace Reference

Classes
class	DataSource

Functions
None	set_source_type (t)
def	get_game_data ()
	Get meta data of the IGN games collection. More...
List[City]	get_us_cities_data (**kwargs)
	retrieves a set of cities filtered by provided arguments More...
List[City]	get_world_cities_data (**kwargs)
def	get_us_map_county_data (state_name=[], view_counties=True)
def	get_us_map_data ()
	See https://bridgesuncc.github.io/tutorials/Map.html on how to use these objects. More...
def	get_all_us_map_county_data ()
	See https://bridgesuncc.github.io/tutorials/Map.html on how to use these objects. More...
def	get_world_map_data (countries=[])
	Gets the country information for the provided countries. More...
ActorMovieIMDB	get_actor_movie_imdb_data (count=0)
	Get ActorMovie IMDB Data. More...
List[ActorMovieIMDB]	get_actor_movie_imdb_data2 ()
	Get ActorMovie IMDB Data. More...
List[EarthquakeUSGS]	get_earthquake_usgs_data (count=0)
	Get USGS earthquake data. More...
List[Shakespeare]	get_shakespeare_data (endpoint="", textonly=False)
	Get data of Shakespeare works (plays, poems) More...
List[GutenbergBook]	get_gutenberg_book_data (num=0)
	Get meta data of the Gutenberg book collection (1000 books) More...
List[CancerIncidence]	get_cancer_incident_data (num=0)
	Retrieves the CDC cancer incidence dataset. More...
Song	get_song (songTitle, artistName=None)
	Get data of a particular song (including lyrics) using the Genius API. More...
List[Song]	get_song_data ()
	Get data of the songs (including lyrics) using the Genius API. More...
ColorGrid	get_color_grid_from_assignment (str server, str user, int assignment, int subassignment=0)
	Reconstruct a ColorGrid from an existing ColorGrid on the bridges server. More...
OsmData	get_osm_data (*args)
	This method retrieves an OpenStreet Map dataset given a location. More...
ElevationData	get_elevation_data (*args)
	This method retrieves an Elevation Map dataset, given a location by name (string). More...
List[MovieActorWikiData]	get_wiki_data_actor_movie (year_begin, year_end)
	This method retrieves an actor-movie data from Wikidata. More...
List[Amenity]	get_amenity_data (*args)
	This method retrieves amenity data from Open Street Map datasets. More...
List[GutenbergMeta]	get_gutenberg_book_metadata (*args)
	function to search for a gutenberg book given a search string and type of metadata to search through More...
GutenbergMeta	get_a_gutenberg_book_metadata (id)
def	gutenberg_book_text (id, strip=False)
List[str]	available_subreddits ()
List[Reddit]	reddit_data (subreddit, time_request=-9999)

Variables
string	source_type = "live"
	force = os.getenv("FORCE_BRIDGES_DATADEBUG", "")

Function Documentation

available_subreddits()

List[str] bridges.data_src_dependent.data_source.available_subreddits

(

)

get_a_gutenberg_book_metadata()

GutenbergMeta bridges.data_src_dependent.data_source.get_a_gutenberg_book_metadata

(

id

)

get_actor_movie_imdb_data()

ActorMovieIMDB bridges.data_src_dependent.data_source.get_actor_movie_imdb_data

(

count = 0

)

Get ActorMovie IMDB Data.

Data is retrieved, formatted into a list of ActorMovieIMDB objects

Parameters

count

count of the number of actor/movie pairs, but currently unused, returns all records.

Returns

a list of ActorMovieIMDB objects, but only actor and movie fields in this version

Exceptions

Exception

if the request fails

get_actor_movie_imdb_data2()

List[ActorMovieIMDB] bridges.data_src_dependent.data_source.get_actor_movie_imdb_data2

(

)

Get ActorMovie IMDB Data.

Data is retrieved, formatted into a list of ActorMovieIMDB objects

Parameters

count

the number of actor/movie pairs, but currently unused,

Returns

All records.

Throws

Exception if the request fails

get_all_us_map_county_data()

def bridges.data_src_dependent.data_source.get_all_us_map_county_data

(

)

See https://bridgesuncc.github.io/tutorials/Map.html on how to use these objects.

get_amenity_data()

List[Amenity] bridges.data_src_dependent.data_source.get_amenity_data

(

*

args

)

This method retrieves amenity data from Open Street Map datasets.

Valid types are "food", "school", "firestation", "airport", "heli"

Parameters

minLat	minimum latitude of the bounding box (float)
minLon	minimum longitude of the bounding box (float)
maxLat	maximum latitude of the bounding box (float)
maxLon	maximum longitude of the bounding box (float)
type	amenity type (str)

Args alternatively:

Parameters

locname	name of a city (str)
type	amenity type (str)

Returns

A list of amenities

get_cancer_incident_data()

List[CancerIncidence] bridges.data_src_dependent.data_source.get_cancer_incident_data

(

num = 0

)

Retrieves the CDC cancer incidence dataset.

Returns a list of records. See CancerIncidence class for more information

Parameters

num	count of records to be retrieved

Returns

cancer incidence data records in a list

get_color_grid_from_assignment()

ColorGrid bridges.data_src_dependent.data_source.get_color_grid_from_assignment	(	str	server,
		str	user,
		int	assignment,
		int	subassignment = 0
	)

Reconstruct a ColorGrid from an existing ColorGrid on the bridges server.

This method can be useful in early CS courses like CS1 or CS2 to work with an existing data structure holding a dataset, like an image.

Parameters

server	server holding the assignment
user	user name
assignment	assignment number
subassignment	sub-assignment number

Returns

ColorGrid structure

get_earthquake_usgs_data()

List[EarthquakeUSGS] bridges.data_src_dependent.data_source.get_earthquake_usgs_data

(

count = 0

)

Get USGS earthquake data.

USGS Tweet data (https://earthquake.usgs.gov/earthquakes/map/). Data retrieved, formatted into a list of EarthquakeUSGS objects. The most recent earthqaukes are returned.

Parameters

count

the number of earthquake records retrieved

Exceptions

Exception

if the request fails

Returns

a list of earthquake records

get_elevation_data()

ElevationData bridges.data_src_dependent.data_source.get_elevation_data

(

*

args

)

This method retrieves an Elevation Map dataset, given a location by name (string).

Parameters

args	a bounding box, aka an array [minLat, minLon, maxLat, maxLon]
args	spatial resolution, aka the distance between two samples (in degrees)

Returns

Elevation data for the bounding box and resolution requested (approximately) [type: ElevationData]

get_game_data()

def bridges.data_src_dependent.data_source.get_game_data

(

)

Get meta data of the IGN games collection.

This function retrieves and formats the data into a list of Game objects

Exceptions

Exception

if the request fails

Returns

a list of Game objects,

get_gutenberg_book_data()

List[GutenbergBook] bridges.data_src_dependent.data_source.get_gutenberg_book_data

(

num = 0

)

Get meta data of the Gutenberg book collection (1000 books)

This function retrieves, and formats the data into a list of GutenbergBook objects

(deprecated you may want to use get_gutenberg_book_metadata() instead. )

Exceptions

Exception

if the request fails

Returns

A list of GutenbergBook objects,

get_gutenberg_book_metadata()

List[GutenbergMeta] bridges.data_src_dependent.data_source.get_gutenberg_book_metadata

(

*

args

)

function to search for a gutenberg book given a search string and type of metadata to search through

:param args: args search string, i.e home args metadata type, i.e id, title, lang, date_added, authors, genres, loc_class

:return: a list of books with containing matched strings from the specified metadata type

get_osm_data()

OsmData bridges.data_src_dependent.data_source.get_osm_data

(

*

args

)

This method retrieves an OpenStreet Map dataset given a location.

The function can either take a city name or a bounding box in lat/long. The city name can be taken from the list at http://osm-data.bridgesuncc.org/cities

The function also take a level of detail which can be anything in ["motorway", "trunk", "primary", "secondary", "tertiary, "unclassified", "residential", "living_street", "service", "trails", "walking", "bicycle" ]

Parameters

locname	name of a city (str)
level	level of detail (str)

Args alternatively:

Parameters

minLat	minimum latitude of the bounding box (float)
minLon	minimum longitude of the bounding box (float)
maxLat	maximum latitude of the bounding box (float)
maxLon	maximum longitude of the bounding box (float)
level	level of detail (str)

Returns

OsmData

get_shakespeare_data()

List[Shakespeare] bridges.data_src_dependent.data_source.get_shakespeare_data	(		endpoint = "",
			textonly = False
	)

Get data of Shakespeare works (plays, poems)

This function retrieves and formats the data into a a list of Shakespeare objects.

Valid 'poems','plays' Valid format{simple}

Exceptions

Exception

if the request fails

Parameters

endpoint	can be either "plays" or "poems". If this is specified, then only these types of works are retrieved.
textonly	if this is set, then only the text is retrieved.

Returns

An array of Shakespeare objects

get_song()

Song bridges.data_src_dependent.data_source.get_song	(		songTitle,
			artistName = None
	)

Get data of a particular song (including lyrics) using the Genius API.

Data from Genius API(https://docs.genius.com/), given the song title and artist name. Valid http://static-data.bridgesuncc.org/api/songs/find/ Valid song title, artist name

This function retrieves and formats the data into a Song object. The song if not cached in the local DB is queried and added to the DB

Parameters

songTitle	title of song
artistName	name of artist

Exceptions

Exception

if the request fails

Returns

a Song object,

get_song_data()

List[Song] bridges.data_src_dependent.data_source.get_song_data

(

)

Get data of the songs (including lyrics) using the Genius API.

Song data from https://docs.genius.com/. Valid https://static-data.bridgesuncc.org/api/songs/

This function retrieves and formats the data into a list of Song objects. This version of the API retrieves all the cached songs in the local DB.

Exceptions

Exception

if the request fails

Returns

A list of Song objects,

get_us_cities_data()

List[City] bridges.data_src_dependent.data_source.get_us_cities_data

(

**

kwargs

)

retrieves a set of cities filtered by provided arguments

Parameters

kwargs

can be one or more of the following: 'city': city name 'state': US state 'timezone': cities within this timezone 'min_pop': include cities larger than this number 'max_pop': include cities smaller than this number 'min_elev': include cities larger than this elevation 'max_elev': include cities smaller than this elevation 'min_lat': min latitude 'min_long': min longitude 'max_lat': max latitude 'max_long': max longtude 'limit': number of cities to be included

get_us_map_county_data()

def bridges.data_src_dependent.data_source.get_us_map_county_data	(		state_name = [],
			view_counties = True
	)

get_us_map_data()

def bridges.data_src_dependent.data_source.get_us_map_data

(

)

See https://bridgesuncc.github.io/tutorials/Map.html on how to use these objects.

get_wiki_data_actor_movie()

List[MovieActorWikiData] bridges.data_src_dependent.data_source.get_wiki_data_actor_movie	(		year_begin,
			year_end
	)

This method retrieves an actor-movie data from Wikidata.

Uses a sparql query

Parameters

year_begin	beginning year of data request
year_end	ending year of data request

Returns

A list of the actor-movie data of type MovieActorWikiData

get_world_cities_data()

List[City] bridges.data_src_dependent.data_source.get_world_cities_data

(

**

kwargs

)

get_world_map_data()

def bridges.data_src_dependent.data_source.get_world_map_data

(

countries = []

)

Gets the country information for the provided countries.

For now, reading from a data file containing the country data as a JSON See https://bridgesuncc.github.io/tutorials/WorldMap.html on how to use these objects

gutenberg_book_text()

def bridges.data_src_dependent.data_source.gutenberg_book_text	(		id,
			strip = False
	)

reddit_data()

List[Reddit] bridges.data_src_dependent.data_source.reddit_data	(		subreddit,
			time_request = -9999
	)

set_source_type()

None bridges.data_src_dependent.data_source.set_source_type

(

t

)

Variable Documentation

force

bridges.data_src_dependent.data_source.force = os.getenv("FORCE_BRIDGES_DATADEBUG", "")

source_type

string bridges.data_src_dependent.data_source.source_type = "live"