Skip to main content

Package that provides information about U.S states and territories.

Project description

U.S States

U.S States is a python package that provides information about states. This package is currently being built, so there is information that will be missing at the moment.

GitHub contributors Discord GitHub issues GitHub closed issues

Documents

Install

The package can be downloaded from PyPi by using pip3 in the following way:

pip3 install unitedstates

States

Before we get started, we need to define if we will grant DC statehood.

# If DC will be counted as a state
from states import States_Abbreviated
states_abbreviated = States_Abbreviated(DC_Statehood=True)

# If DC will not be counted as a state
from states import States_Full_Name
states_full_name = States_Full_Name(DC_Statehood=False)

States are divided by regions and divisions in accordance with the U.S Census. The following are the divisions, which are class attributes.

  • east_north_central
  • east_south_central
  • mid_atlantic
  • mountain
  • new_england
  • pacific
  • south_atlantic
  • west_north_central
  • west_south_central
mountain_states = states_full_name.mountain

The following are regions, which are class attributes.

  • northeast_region
  • midwest_region
  • south_region

In order to retrieve all the states, the all_states attribute can be used.

These attributes can be found on both the States_Full_Name() and States_Abbreviated() class.

This package contains information about each state, here is a list of the info included:

  • official_name
  • full_name
  • abbreviated
  • capital
  • population
  • area_sq_km
  • time_zone
  • region

In order to retrieve this info, the get_states_info() method can be use.

from states import States
states = States()
virginia_info = states.get_state_info('Virginia')

Which would return the following.

{   "official_name":"Commonwealth of Virginia",
    "full_name":"Virginia",
    "abbreviated":"VA",
    "capital":"Richmond",
    "population": 8535519,
    "area_sq_km":110786,
    "time_zone": ["Eastern Standard Time","GMT-5"],
    "region":"South Atlantic"}

Keep in mind Some states contain more than one time zone depending which town you are located. At the moment, the info only contains the major one.

You can pull all the available states by passing the function "all".

Territories

You can access the territory classes by importing them from states. Territories have the following classes:

  • Territories_Abbreviated
  • Territories_Full_Name
  • Associated_States
  • Uninhabitated_Territories
from states import Territories_Abbreviated

Both the Territories_Abbreviated and Territories_Full_Name contain the following attributes:

  • atlantic
  • pacific
  • all_territories
atlantic_territories = Territories_Abbreviated().atlantic

Associated_States contains the following attributes:

  • pacific_abbreviated
  • pacific_full_name

Uninhabitated_Territories contains the following attributes:

  • all_territories

This package contains information about each state, here is a list of the info included:

  • official_name
  • full_name
  • abbreviated
  • capital
  • population
  • area_sq_km
  • time_zone
  • region

In order to retrieve this info, the get_territory_info() method can be use.

from states import Territories
territories = Territories()
virginia_info = territories.get_territory_info('Puerto Rico')

Which would return the following.

{   "official_name":"Commonwealth of Puerto Rico",
    "full_name":"Puerto Rico",
    "abbreviated":"PR",
    "capital":"San Juan",
    "population": 3193694,
    "area_sq_km":9104,
    "time_zone": ["Atlantic Standard Time","GMT-4"],
    "region":"Atlantic"}

You can pull all the available territories by passing the function "all".

Contribution

We welcome everyone that wants to contribute. Please see the contribution page for guidelines on contributing and submitting feature requests.

Join us in social media!

Resources used

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unitedstates-0.0.1.7.tar.gz (9.6 kB view hashes)

Uploaded source

Built Distribution

unitedstates-0.0.1.7-py3-none-any.whl (15.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page