Skip to content

Commit 1122c35

Browse files
jcarbaughjcarbaugh
authored
Move changelog to CHANGELOG.md (#94)
1 parent 8082fad commit 1122c35

2 files changed

Lines changed: 126 additions & 112 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Changelog
2+
3+
## 4.0.0
4+
5+
* add counties, thanks to [Ray Kiddy](https://github.com/rkiddy)
6+
* DC has returned to `STATES_AND_TERRITORIES`, thanks to [Kavi Gupta](https://github.com/kavigupta)
7+
* fix `py.typed` location, thanks to [johnw-bluemark](https://github.com/johnw-bluemark)
8+
* add support for Python 3.13 and 3.14
9+
* switch to [uv](https://docs.astral.sh/uv/) for development and packaging
10+
* switch from black and flake8 to [ruff](https://docs.astral.sh/ruff/)
11+
* thanks to maintainer [Pedro Camargo](https://github.com/pedrocamargo)
12+
13+
14+
## 3.2.0
15+
16+
* add support for Python 3.12
17+
* drop support for Python 3.6 and 3.7
18+
* add birthday attribute to unitedstatesofamerica
19+
* upgrade to jellyfish 1.x
20+
* thanks to [Paul Hawk](https://github.com/pauldhawk), [David Gilman](https://github.com/dgilmanAIDENTIFIED), [Sergii Bondarenko](https://github.com/BR0kEN-), and [Pedro Camargo](https://github.com/pedrocamargo)
21+
22+
23+
## 3.1.1
24+
25+
* add support for Python 3.11
26+
* upgrade to jellyfish 0.11.2
27+
28+
29+
## 3.0.0
30+
31+
* upgrade to jellyfish 0.7.2
32+
* drop support for Python 2.7
33+
* add us.states.COMMONWEALTHS list of states that call themselves commonwealths 🎩
34+
* add DC to STATES, STATES_AND_TERRITORIES, STATES_CONTIGUOUS, or STATES_CONTINENTAL when DC_STATEHOOD environment variable is set
35+
* remove `region` parameter from `shapefile_urls()` method
36+
* `mapping()` no longer includes obsolete states
37+
* added type annotations
38+
39+
40+
## 2.0.2
41+
42+
* restore DC in `lookup()` and `mapping()`
43+
44+
45+
## 2.0.1
46+
47+
* fix Python 2.7 tests that ran with Python 3
48+
* revert to jellyfish 0.6.1 to support Python 2.7
49+
50+
51+
## 2.0.0
52+
53+
* add support for Python 3.7 and 3.8
54+
* remove support for Python 3.4 and 3.5
55+
* remove pickled objects and database in favor of pure Python code
56+
* upgrade jellyfish to 0.7.2 to fix metaphone bug
57+
* fixes for IN, KY, ND, and NM timezones
58+
* set AZ timezone to America/Phoenix
59+
* obsolete entries are no longer included in STATES_AND_TERRITORIES
60+
* DC is no longer included in STATES, STATES_AND_TERRITORIES, STATES_CONTIGUOUS, or STATES_CONTINENTAL
61+
62+
63+
## 1.0.0
64+
65+
* full Python 3.6 support
66+
* use pytest
67+
68+
69+
## 0.10.0
70+
71+
* upgrade jellyfish to 0.5.3 to fix metaphone bug
72+
73+
## 0.9.0
74+
75+
* add information on whether a state is contiguous and/or continental,
76+
thanks to [chebee7i](https://github.com/chebee7i)
77+
78+
## 0.8.0
79+
80+
* add obsolete territories, thanks to [Ben Chartoff](https://github.com/bchartoff)
81+
* fix packaging error, thanks to [Alexander Kulakov](https://github.com/momyc)
82+
83+
84+
## 0.7.1
85+
86+
* upgrade to jellyfish 0.5.1 to fix metaphone case bug
87+
88+
## 0.7
89+
90+
* add time zones, thanks to [Paul Tagliamonte](https://github.com/paultag)
91+
* Python 2.6 and 3.2 compatibility
92+
93+
## 0.6
94+
95+
* add AP-style state abbreviations
96+
* use jellyfish instead of Metaphone package
97+
* update to requests v1.0.4 for tests
98+
* Python 3.3 compatibility
99+
100+
## 0.5
101+
102+
* fix state abbreviation for Nebraska
103+
104+
## 0.4
105+
106+
* add state capitals
107+
* add years of statehood
108+
109+
## 0.3
110+
111+
* add mapping method to generate dicts of arbitrary fields
112+
113+
## 0.2
114+
115+
* add command line script for quick access to state data
116+
117+
## 0.1
118+
119+
* initial release
120+
* state names and abbreviations
121+
* FIPS codes
122+
* `lookup()` method
123+
* shapefile URLs for various regions

‎README.md‎

Lines changed: 3 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -238,120 +238,11 @@ GitHub Actions are set up to automatically run unit tests against any new
238238
commits to the repo. To run these tests yourself:
239239

240240
```
241-
pip install -e .[dev]
242-
pytest .
241+
uv sync
242+
uv run pytest
243243
```
244244

245245

246246
## Changelog
247247

248-
### 3.2.0
249-
250-
* add support for Python 3.12
251-
* drop support for Python 3.6 and 3.7
252-
* add birthday attribute to unitedstatesofamerica
253-
* upgrade to jellyfish 1.x
254-
* thanks to [Paul Hawk](https://github.com/pauldhawk), [David Gilman](https://github.com/dgilmanAIDENTIFIED), [Sergii Bondarenko](https://github.com/BR0kEN-), and [Pedro Camargo](https://github.com/pedrocamargo)
255-
256-
257-
### 3.1.1
258-
259-
* add support for Python 3.11
260-
* upgrade to jellyfish 0.11.2
261-
262-
263-
### 3.0.0
264-
265-
* upgrade to jellyfish 0.7.2
266-
* drop support for Python 2.7
267-
* add us.states.COMMONWEALTHS list of states that call themselves commonwealths 🎩
268-
* add DC to STATES, STATES_AND_TERRITORIES, STATES_CONTIGUOUS, or STATES_CONTINENTAL when DC_STATEHOOD environment variable is set
269-
* remove `region` parameter from `shapefile_urls()` method
270-
* `mapping()` no longer includes obsolete states
271-
* added type annotations
272-
273-
274-
### 2.0.2
275-
276-
* restore DC in `lookup()` and `mapping()`
277-
278-
279-
### 2.0.1
280-
281-
* fix Python 2.7 tests that ran with Python 3
282-
* revert to jellyfish 0.6.1 to support Python 2.7
283-
284-
285-
### 2.0.0
286-
287-
* add support for Python 3.7 and 3.8
288-
* remove support for Python 3.4 and 3.5
289-
* remove pickled objects and database in favor of pure Python code
290-
* upgrade jellyfish to 0.7.2 to fix metaphone bug
291-
* fixes for IN, KY, ND, and NM timezones
292-
* set AZ timezone to America/Phoenix
293-
* obsolete entries are no longer included in STATES_AND_TERRITORIES
294-
* DC is no longer included in STATES, STATES_AND_TERRITORIES, STATES_CONTIGUOUS, or STATES_CONTINENTAL
295-
296-
297-
### 1.0.0
298-
299-
* full Python 3.6 support
300-
* use pytest
301-
302-
303-
### 0.10.0
304-
305-
* upgrade jellyfish to 0.5.3 to fix metaphone bug
306-
307-
### 0.9.0
308-
309-
* add information on whether a state is contiguous and/or continental,
310-
thanks to [chebee7i](https://github.com/chebee7i)
311-
312-
### 0.8.0
313-
314-
* add obsolete territories, thanks to [Ben Chartoff](https://github.com/bchartoff)
315-
* fix packaging error, thanks to [Alexander Kulakov](https://github.com/momyc)
316-
317-
318-
### 0.7.1
319-
320-
* upgrade to jellyfish 0.5.1 to fix metaphone case bug
321-
322-
### 0.7
323-
324-
* add time zones, thanks to [Paul Tagliamonte](https://github.com/paultag)
325-
* Python 2.6 and 3.2 compatibility
326-
327-
### 0.6
328-
329-
* add AP-style state abbreviations
330-
* use jellyfish instead of Metaphone package
331-
* update to requests v1.0.4 for tests
332-
* Python 3.3 compatibility
333-
334-
### 0.5
335-
336-
* fix state abbreviation for Nebraska
337-
338-
### 0.4
339-
340-
* add state capitals
341-
* add years of statehood
342-
343-
### 0.3
344-
345-
* add mapping method to generate dicts of arbitrary fields
346-
347-
### 0.2
348-
349-
* add command line script for quick access to state data
350-
351-
### 0.1
352-
353-
* initial release
354-
* state names and abbreviations
355-
* FIPS codes
356-
* `lookup()` method
357-
* shapefile URLs for various regions
248+
See [CHANGELOG.md](CHANGELOG.md) for a history of changes.

0 commit comments

Comments
 (0)