Add associated states (Marshall Islands, FSM, Palau) as ASSOCIATED_STATES

.gitignore

@@ -8,6 +8,7 @@ dist/
 .cache/
 .mypy_cache/
 .pytest_cache/
+.ruff_cache/
 .tox/
 __pycache__/
 *.pyc

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 4.0.0
 
 * add counties, thanks to [Ray Kiddy](https://github.com/rkiddy)
+* add `ASSOCIATED_STATES` list with entries for Marshall Islands, Federated States of Micronesia, and Palau, plus a new `is_associated` attribute on `State`
 * add `clean_name()` method and `fallback_func` parameter to `lookup()` to provide customizable matching, thanks to [Max Filenko](https://github.com/mfilenko) and [Charlie Tonneslan](https://github.com/c-tonneslan)
 * DC has returned to `STATES_AND_TERRITORIES`, thanks to [Kavi Gupta](https://github.com/kavigupta)
 * change ND time zone from America/Boise to America/Denver

README.md

@@ -104,7 +104,17 @@ Some states like to be fancy and call themselves commonwealths:
 [<State:Kentucky>, <State:Massachusetts>, <State:Pennsylvania>, <State:Virginia>]
 ```
 
-There's also a list of obsolete territories:
+There's a list of associated states, sovereign nations in free association with
+the United States under the Compact of Free Association. They are not US
+states or territories and are not included in `STATES_AND_TERRITORIES` or
+returned by `lookup()`:
+
+```python
+>>> us.states.ASSOCIATED_STATES
+[<State:Federated States of Micronesia>, <State:Marshall Islands>, <State:Palau>]
+```
+
+And a list of obsolete territories:
 
 ```python
 >>> us.states.OBSOLETE

us/__init__.py

@@ -5,6 +5,7 @@
     TERRITORIES,
     STATES_AND_TERRITORIES,
     OBSOLETE,
+    ASSOCIATED_STATES,
 )
 from .unitedstatesofamerica import name, abbr, birthday
 
@@ -33,6 +34,7 @@ def __getattr__(name):
     "TERRITORIES",
     "STATES_AND_TERRITORIES",
     "OBSOLETE",
+    "ASSOCIATED_STATES",
     "name",
     "abbr",
     "birthday",