Metadata-Version: 2.4
Name: pyshp-stubs
Version: 0.0.1
Summary: Static typing indicator for PyShp 3 (which is already typed).  PyShp is a pure Python read/write support for ESRI Shapefile format
Project-URL: Repository, https://github.com/JamesParrott/PyShp-stubs
Author-email: James Parrott <james@jamesparrott.dev>
Maintainer-email: James Parrott <james@jamesparrott.dev>
License-Expression: MIT
Keywords: geographic,geospatial,gis,shapefile,shapefiles
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# PyShp-stubs
This package is intended to be shipped from the main PyShp repo eventually 
not this personal one (once mypy finds it).

Nominal type stubs for PyShp.

PyShp 3 is statically typed.  PyShp has historically been a single file library (shapefile.py).

According to PEP 561, and [the spec](https://typing.python.org/en/latest/spec/distributing.html#packaging-typed-libraries) in order to add a py.typed marker file (without indicating to type checkers
that every package the user has installed adajacent to PyShp should also be type checked, regardless of whether all such packages support that or not), "The single-file module should be refactored into a package".

Myself and several other project contributers are reluctant to give up the single-file module (shapefile.py).  We quite like it.  

The purpose of this package is purely to indicate to type-checkers that PyShp is typed.  It just so happens to be primarily typed in-line in the main library, from which the stubs in shapefile.pyi are largely automatically generated by MyPy's stubgen.