/us-states

Python package that provides information about U.S states.

Primary LanguagePythonBoost Software License 1.0BSL-1.0

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

States

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

# If DC will be counted as a state
states_abbreviated = States_Abbreviated(True)

# If DC will not be counted as a state
states_full_name = States_Full_Name(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

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.

Territories

Territories have the following classes:

  • Territories_Abbreviated
  • Territories_Full_Name
  • Associated_States
  • Uninhabitated_Territories

Both the Territories_Abbreviated and Territories_Full_Name contain the following attributes:

  • atlantic
  • pacific
  • all_territories

Associated_States contains the following attributes:

  • pacific_abbreviated
  • pacific_full_name

Uninhabitated_Territories contains the following attributes:

  • all_territories

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