From 11c8d49b4973052d7ba9bff8487477fc8050c18d Mon Sep 17 00:00:00 2001 From: Adam Deitsch Date: Fri, 1 Dec 2023 17:04:56 +0000 Subject: [PATCH 1/2] Defined names and abbreviations for states. --- __init__.py | 13 ++++- docs/pyaqsapi.rst | 73 +++++++++++++++--------- pyaqsapi.rst | 8 +++ pyaqsapi/__init__.py | 12 +++- pyaqsapi/textvariables.py | 115 ++++++++++++++++++++++++++++++++++++++ 5 files changed, 194 insertions(+), 27 deletions(-) create mode 100644 pyaqsapi/textvariables.py diff --git a/__init__.py b/__init__.py index 9044156..c8dfcb4 100644 --- a/__init__.py +++ b/__init__.py @@ -10,6 +10,16 @@ import pyaqsapi.bypqao.bypqao as bypqao import pyaqsapi.bycbsa.bycbsa as bycbsa +from .textvariables import (Alabama, AL, Alaska, AK, Arizona, AZ, Arkansas, AR, California, CA, Colorado, CO, Connecticut, CT, + Delaware, DE, DistrictOfColumbia, DC, Florida, FL, Georgia, GA, Hawaii, HI, Idaho, ID, Illinois, IL, Indiana, IN, + Iowa, IA, Kansas, KS, Kentucky, KY, Louisiana, LA, Maine, ME, Maryland, MD, Massachusetts, MA, Michigan, MI, Minnesota, MN, + Mississippi, MS, Missouri, MO, Montana, MT, Nebraska, NE, Nevada, NV, NewHampshire, NH, NewJersey, NJ, NewMexico, NM, + NewYork, NY, NorthCarolina, NC, NorthDakota, ND, Ohio, OH, Oklahoma, OK, Oregon, OR, Pennsylvania, PA, RhodeIsland, RI, + SouthCarolina, SC, SouthDakota, SD, Tennessee, TN, Texas, TX, Utah, UT, Vermont, VT, Virginia, VA, Washington, WA, + WestVirginia, WV, Wisconsin, WI, Wyoming, WY, Guam, GU, PuertoRico, PR, VirginIslands, VI, Mexico, MX, Canada, CAN) + + + # from pyaqsapi.bysite import bysite as bysite # from pyaqsapi.bycounty import bycounty as bycounty @@ -32,4 +42,5 @@ # 'bycbsa/', # 'bybox/', "listfunctions", -] + "textvariables", +] \ No newline at end of file diff --git a/docs/pyaqsapi.rst b/docs/pyaqsapi.rst index 05090ed..e176d61 100644 --- a/docs/pyaqsapi.rst +++ b/docs/pyaqsapi.rst @@ -4,64 +4,72 @@ pyaqsapi package Submodules ---------- -pyaqsapi.bybox.bybox module -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +pyaqsapi.aqsmultiyearparams module +---------------------------------- -.. automodule:: pyaqsapi.bybox.bybox +.. automodule:: pyaqsapi.aqsmultiyearparams :members: :undoc-members: :show-inheritance: -pyaqsapi.bycbsa.bycbsa module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +pyaqsapi.bybox module +--------------------- -.. automodule:: pyaqsapi.bycbsa.bycbsa +.. automodule:: pyaqsapi.bybox :members: :undoc-members: :show-inheritance: -pyaqsapi.bycounty.bycounty module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +pyaqsapi.bycbsa module +---------------------- -.. automodule:: pyaqsapi.bycounty.bycounty +.. automodule:: pyaqsapi.bycbsa :members: :undoc-members: :show-inheritance: -pyaqsapi.byma.byma module -~~~~~~~~~~~~~~~~~~~~~~~~~ +pyaqsapi.bycounty module +------------------------ -.. automodule:: pyaqsapi.byma.byma +.. automodule:: pyaqsapi.bycounty :members: :undoc-members: :show-inheritance: -pyaqsapi.bypqao.bypqao module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +pyaqsapi.byma module +-------------------- -.. automodule:: pyaqsapi.bypqao.bypqao +.. automodule:: pyaqsapi.byma :members: :undoc-members: :show-inheritance: -pyaqsapi.bysite.bysite module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +pyaqsapi.bypqao module +---------------------- -.. automodule:: pyaqsapi.bysite.bysite +.. automodule:: pyaqsapi.bypqao :members: :undoc-members: :show-inheritance: -pyaqsapi.bystate.bystate module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +pyaqsapi.bysite module +---------------------- -.. automodule:: pyaqsapi.bystate.bystate +.. automodule:: pyaqsapi.bysite + :members: + :undoc-members: + :show-inheritance: + +pyaqsapi.bystate module +----------------------- + +.. automodule:: pyaqsapi.bystate :members: :undoc-members: :show-inheritance: pyaqsapi.helperfunctions module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------- .. automodule:: pyaqsapi.helperfunctions :members: @@ -69,7 +77,7 @@ pyaqsapi.helperfunctions module :show-inheritance: pyaqsapi.listfunctions module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +----------------------------- .. automodule:: pyaqsapi.listfunctions :members: @@ -77,7 +85,7 @@ pyaqsapi.listfunctions module :show-inheritance: pyaqsapi.metadatafunctions module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +--------------------------------- .. automodule:: pyaqsapi.metadatafunctions :members: @@ -85,10 +93,25 @@ pyaqsapi.metadatafunctions module :show-inheritance: pyaqsapi.setupfunctions module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------ .. automodule:: pyaqsapi.setupfunctions :members: :undoc-members: :show-inheritance: +pyaqsapi.textvariables module +------------------------------ + +.. automodule:: pyaqsapi.textvariables + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyaqsapi + :members: + :undoc-members: + :show-inheritance: diff --git a/pyaqsapi.rst b/pyaqsapi.rst index 22741b9..e176d61 100644 --- a/pyaqsapi.rst +++ b/pyaqsapi.rst @@ -100,6 +100,14 @@ pyaqsapi.setupfunctions module :undoc-members: :show-inheritance: +pyaqsapi.textvariables module +------------------------------ + +.. automodule:: pyaqsapi.textvariables + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/pyaqsapi/__init__.py b/pyaqsapi/__init__.py index 9044156..33570e9 100644 --- a/pyaqsapi/__init__.py +++ b/pyaqsapi/__init__.py @@ -10,6 +10,15 @@ import pyaqsapi.bypqao.bypqao as bypqao import pyaqsapi.bycbsa.bycbsa as bycbsa +from .textvariables import (Alabama, AL, Alaska, AK, Arizona, AZ, Arkansas, AR, California, CA, Colorado, CO, Connecticut, CT, + Delaware, DE, DistrictOfColumbia, DC, Florida, FL, Georgia, GA, Hawaii, HI, Idaho, ID, Illinois, IL, Indiana, IN, + Iowa, IA, Kansas, KS, Kentucky, KY, Louisiana, LA, Maine, ME, Maryland, MD, Massachusetts, MA, Michigan, MI, Minnesota, MN, + Mississippi, MS, Missouri, MO, Montana, MT, Nebraska, NE, Nevada, NV, NewHampshire, NH, NewJersey, NJ, NewMexico, NM, + NewYork, NY, NorthCarolina, NC, NorthDakota, ND, Ohio, OH, Oklahoma, OK, Oregon, OR, Pennsylvania, PA, RhodeIsland, RI, + SouthCarolina, SC, SouthDakota, SD, Tennessee, TN, Texas, TX, Utah, UT, Vermont, VT, Virginia, VA, Washington, WA, + WestVirginia, WV, Wisconsin, WI, Wyoming, WY, Guam, GU, PuertoRico, PR, VirginIslands, VI, Mexico, MX, Canada, CAN) + + # from pyaqsapi.bysite import bysite as bysite # from pyaqsapi.bycounty import bycounty as bycounty @@ -32,4 +41,5 @@ # 'bycbsa/', # 'bybox/', "listfunctions", -] + "textvariables", +] \ No newline at end of file diff --git a/pyaqsapi/textvariables.py b/pyaqsapi/textvariables.py new file mode 100644 index 0000000..6150ec4 --- /dev/null +++ b/pyaqsapi/textvariables.py @@ -0,0 +1,115 @@ +"""textvariables.py""" + +# Text strings to allow simpler input into `pyaqsapi.bystate()` +Alabama = '01' +AL = '01' +Alaska = '02' +AK = '02' +Arizona = '04' +AZ = '04' +Arkansas = '05' +AR = '05' +California = '06' +CA = '06' +Colorado = '08' +CO = '08' +Connecticut = '09' +CT = '09' +Delaware = '10' +DE = '10' +DistrictOfColumbia = '11' +DC = '11' +Florida = '12' +FL = '12' +Georgia = '13' +GA = '13' +Hawaii = '15' +HI = '15' +Idaho = '16' +ID = '16' +Illinois = '17' +IL = '17' +Indiana = '18' +IN = '18' +Iowa = '19' +IA = '19' +Kansas = '20' +KS = '20' +Kentucky = '21' +KY = '21' +Louisiana = '22' +LA = '22' +Maine = '23' +ME = '23' +Maryland = '24' +MD = '24' +Massachusetts = '25' +MA = '25' +Michigan = '26' +MI = '26' +Minnesota = '27' +MN = '27' +Mississippi = '28' +MS = '28' +Missouri = '29' +MO = '29' +Montana = '30' +MT = '30' +Nebraska = '31' +NE = '31' +Nevada = '32' +NV = '32' +NewHampshire = '33' +NH = '33' +NewJersey = '34' +NJ = '34' +NewMexico = '35' +NM = '35' +NewYork = '36' +NY = '36' +NorthCarolina = '37' +NC = '37' +NorthDakota = '38' +ND = '38' +Ohio = '39' +OH = '39' +Oklahoma = '40' +OK = '40' +Oregon = '41' +OR = '41' +Pennsylvania = '42' +PA = '42' +RhodeIsland = '44' +RI = '44' +SouthCarolina = '45' +SC = '45' +SouthDakota = '46' +SD = '46' +Tennessee = '47' +TN = '47' +Texas = '48' +TX = '48' +Utah = '49' +UT = '49' +Vermont = '50' +VT = '50' +Virginia = '51' +VA = '51' +Washington = '53' +WA = '53' +WestVirginia = '54' +WV = '54' +Wisconsin = '55' +WI = '55' +Wyoming = '56' +WY = '56' +Guam = '66' +GU = '66' +PuertoRico = '72' +PR = '72' +VirginIslands = '78' +VI = '78' +Mexico = '80' +MX = '80' +Canada = 'CC' +CAN = 'CC' From 440fb06df52da83052a624b6dd83b2ce9a3d4fcb Mon Sep 17 00:00:00 2001 From: Adam Deitsch Date: Fri, 1 Dec 2023 17:14:16 +0000 Subject: [PATCH 2/2] Corrected accidental deletions in `docs/pyaqsapi.rst` --- docs/pyaqsapi.rst | 68 ++++++++++++++++++----------------------------- 1 file changed, 26 insertions(+), 42 deletions(-) diff --git a/docs/pyaqsapi.rst b/docs/pyaqsapi.rst index e176d61..da9d080 100644 --- a/docs/pyaqsapi.rst +++ b/docs/pyaqsapi.rst @@ -4,72 +4,64 @@ pyaqsapi package Submodules ---------- -pyaqsapi.aqsmultiyearparams module ----------------------------------- +pyaqsapi.bybox.bybox module +~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: pyaqsapi.aqsmultiyearparams +.. automodule:: pyaqsapi.bybox.bybox :members: :undoc-members: :show-inheritance: -pyaqsapi.bybox module ---------------------- +pyaqsapi.bycbsa.bycbsa module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: pyaqsapi.bybox +.. automodule:: pyaqsapi.bycbsa.bycbsa :members: :undoc-members: :show-inheritance: -pyaqsapi.bycbsa module ----------------------- +pyaqsapi.bycounty.bycounty module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: pyaqsapi.bycbsa +.. automodule:: pyaqsapi.bycounty.bycounty :members: :undoc-members: :show-inheritance: -pyaqsapi.bycounty module ------------------------- +pyaqsapi.byma.byma module +~~~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: pyaqsapi.bycounty +.. automodule:: pyaqsapi.byma.byma :members: :undoc-members: :show-inheritance: -pyaqsapi.byma module --------------------- +pyaqsapi.bypqao.bypqao module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: pyaqsapi.byma +.. automodule:: pyaqsapi.bypqao.bypqao :members: :undoc-members: :show-inheritance: -pyaqsapi.bypqao module ----------------------- +pyaqsapi.bysite.bysite module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: pyaqsapi.bypqao +.. automodule:: pyaqsapi.bysite.bysite :members: :undoc-members: :show-inheritance: -pyaqsapi.bysite module ----------------------- +pyaqsapi.bystate.bystate module +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. automodule:: pyaqsapi.bysite - :members: - :undoc-members: - :show-inheritance: - -pyaqsapi.bystate module ------------------------ - -.. automodule:: pyaqsapi.bystate +.. automodule:: pyaqsapi.bystate.bystate :members: :undoc-members: :show-inheritance: pyaqsapi.helperfunctions module -------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: pyaqsapi.helperfunctions :members: @@ -77,7 +69,7 @@ pyaqsapi.helperfunctions module :show-inheritance: pyaqsapi.listfunctions module ------------------------------ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: pyaqsapi.listfunctions :members: @@ -85,7 +77,7 @@ pyaqsapi.listfunctions module :show-inheritance: pyaqsapi.metadatafunctions module ---------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: pyaqsapi.metadatafunctions :members: @@ -93,7 +85,7 @@ pyaqsapi.metadatafunctions module :show-inheritance: pyaqsapi.setupfunctions module ------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: pyaqsapi.setupfunctions :members: @@ -106,12 +98,4 @@ pyaqsapi.textvariables module .. automodule:: pyaqsapi.textvariables :members: :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: pyaqsapi - :members: - :undoc-members: - :show-inheritance: + :show-inheritance: \ No newline at end of file