get_pop package

Subpackages

• get_pop.modules package
  • Subpackages
    • get_pop.modules.helper package
      • Submodules
      • get_pop.modules.helper.misc module
      • get_pop.modules.helper.move module
      • get_pop.modules.helper.time module
      • Module contents
    • get_pop.modules.init package
      • Submodules
      • get_pop.modules.init.init_program module
      • get_pop.modules.init.pandas_opts module
      • Module contents
    • get_pop.modules.parse package
      • Submodules
      • get_pop.modules.parse.helpers module
      • get_pop.modules.parse.parse module
      • Module contents
  • Module contents

Submodules

get_pop.cli module

get_pop.definitions module

This file contains important project variables.

get_pop.get_pop module

get_pop.get_pop.get_pop(states: List[str], *, save_dir: Union[pathlib.Path, str] = PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/get-pop/checkouts/latest/docs'), selected_fields: List[get_pop.definitions.field_dict] = [{'input_name': 'FIPS', 'output_name': 'fips'}, {'input_name': 'CTYNAME', 'output_name': 'name'}, {'input_name': 'POPESTIMATE2019', 'output_name': 'population'}]) → None

Takes a list of 2-letter US state postal codes, returns CSVs for each state.

Parameters

• List[str] (states) – List of states.

• Union[Path, str] (save_dir) – (Optional) Path where CSV data will be stored. Defaults to current working directory.

• selected_fields (selected_fields_type) – (Optional) A list of dictionaries with fields that should be included in the final CSV for each state. Default fields: “fips”, “name”, “population”

Returns

None.

Module contents

Top-level package for get_pop