CLI¶
pypums-cli¶
Usage:
pypums [OPTIONS] COMMAND [ARGS]...
Options:
-v, --version Show the application's version and exit.
--install-completion [bash|zsh|fish|powershell|pwsh]
Install completion for the specified shell.
--show-completion [bash|zsh|fish|powershell|pwsh]
Show completion for the specified shell, to
copy it or customize the installation.
acs-url¶
Builds URL pointing to the Census Bureau’s FTP server containing the data for the desired ACS.
Usage:
pypums acs-url [OPTIONS]
Options:
--year INTEGER Year of survey (2000 - 2019) [required]
--state TEXT One of the 50 US States or District of Columbia
[required]
--survey TEXT One of '1-', '3-' or '5-year' [default: 1-year]
--sample-unit TEXT Unit of observation (person or household) [default:
person]
download-acs¶
Downloads and, optionally, extracts data related to the specified ACS into a specified directory.
Usage:
pypums download-acs [OPTIONS]
Options:
--year INTEGER Year of survey (2000 - 2019) [required]
--state TEXT One of the 50 US States or District of
Columbia [required]
--survey TEXT One of '1-', '3-' or '5-year' [default:
1-year]
--sample-unit TEXT Unit of observation (person or household)
[default: person]
--data-directory DIRECTORY [default: /home/docs/.pypums/data]
-e, --extract Extract the downloaded zip file? [default:
True]
--overwrite-download / --no-overwrite-download
Overwrite previously downloaded version of
this data [default: no-overwrite-download]
--overwrite-extract / --no-overwrite-extract
Overwrite previously extracted version of
this data [default: no-overwrite-extract]