Skip to content

Commit 435dd3a

Browse files
committed
Update docs
1 parent 5dc6257 commit 435dd3a

File tree

2 files changed

+39
-4
lines changed

2 files changed

+39
-4
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The Python Shapefile Library (PyShp) reads and writes ESRI Shapefiles in pure Py
88

99
- **Author**: [Joel Lawhead](https://github.com/GeospatialPython)
1010
- **Maintainers**: [Karim Bahgat](https://github.com/karimbahgat)
11-
- **Version**: 2.3.1
12-
- **Date**: 28 July, 2022
11+
- **Version**: 3.0.0-alpha
12+
- **Date**: 31 July, 2025
1313
- **License**: [MIT](https://github.com/GeospatialPython/pyshp/blob/master/LICENSE.TXT)
1414

1515
## Contents
@@ -93,6 +93,30 @@ part of your geospatial project.
9393

9494
# Version Changes
9595

96+
## 3.0.0-alpha
97+
98+
### Breaking Changes:
99+
- Python 2 and Python 3.8 support dropped.
100+
- Field info tuple is now a namedtuple (Field) instead of a list.
101+
- Field type codes are now FieldType enum members.
102+
- bbox, mbox and zbox attributes are all new Namedtuples.
103+
- Writer does not mutate shapes.
104+
- New custom subclasses for each shape type: Null, Multipatch, Point, Polyline,
105+
Multipoint, and Polygon, plus the latter 4's M and Z variants (Reader and
106+
Writer are still compatible with their base class, Shape, as before).
107+
- Shape sub classes are creatable from, and serializable to bytes streams,
108+
as per the shapefile spec.
109+
110+
### Code quality
111+
- Statically typed, and checked with Mypy
112+
- Checked with Ruff.
113+
- f-strings
114+
- Remove Python 2 specific functions.
115+
- Run doctests against wheels.
116+
- Testing of wheels before publishing them
117+
- pyproject.toml src layout
118+
- Slow test marked.
119+
96120
## 2.4.0
97121

98122
### Breaking Change. Support for Python 2 and Pythons <= 3.8 to be dropped.

changelog.txt

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
11
VERSION 3.0.0-alpha
22

3-
Python 2 and Python 3.8 support dropped
3+
Breaking Changes:
4+
* Python 2 and Python 3.8 support dropped.
5+
* Field info tuple is now a namedtuple (Field) instead of a list.
6+
* Field type codes are now FieldType enum members.
7+
* bbox, mbox and zbox attributes are all new Namedtuples.
8+
* Writer does not mutate shapes.
9+
* New custom subclasses for each shape type: Null, Multipatch, Point, Polyline,
10+
Multipoint, and Polygon, plus the latter 4's M and Z variants (Reader and
11+
Writer are still compatible with their base class, Shape, as before).
12+
* Shape sub classes are creatable from, and serializable to bytes streams,
13+
as per the shapefile spec.
414

5-
2025-07-22
615
Code quality
16+
* Statically typed and checked with Mypy
17+
* Checked with Ruff.
718
* Type hints
819
* f-strings
920
* Remove Python 2 specific functions.

0 commit comments

Comments
 (0)