pleiades_lpf: Linked Places Format (LPF) tools for Pleiades

pleiades_lpf is written by Tom Elliott for the Pleiades gazetteer of ancient places, a project and publication of the Institute for the Study of the Ancient World at New York University.

Roadmap

At present, still a long way to go on fleshing out the gazetteer model. Tests pass for what is implemented; I am using a JSON LPF file from the World Historical Gazetteer for testing file loading.

Classes

• Geometry

  • Stub the class (in gazetteer.py)
  • asdict function
  • other functionality and data (this is largely untouched as of yet)

• Feature

  • Stub the class (in gazetteer.py)
  • Static attribute type="Feature"
  • asdict function
  • properties attribute (dictionary)
    • Validation of the properties attribute and its contents
    • methods for adding/getting parts of the properties attribute (implement as needed)
  • geometry attribute
  • tests
  • augment

• FeatureCollection

  • Stub the class (in gazetteer.py)
  • Static attribute type="FeatureCollection"
  • Attribute features: list
  • Attribute context: str
  • Attribute validation?
  • asdict function
  • tests
  • augment

• Citation

  • Note that the structure outlined below deviates from LPF v1
  • Stub the class (in citations.py)
  • attributes, including those that need to be Identifier
  • asdict function
  • tests
  • augment

• FeatureType

  • Note that the structure outlined below deviates from LPF v1
  • Stub the class (in gazetteer.py)
  • attribute: @id: Identifier
  • attribute: citations: list of Citations
  • attribute: label: str
  • attribute: aliases: list of str
  • attribute When
  • asdict function
  • tests
  • augment

• Identifier

• identify and stub other classes following GeoJSON and LPF specifications.

package-level functions

• load
  • wrap json function from standard library
  • return FeatureCollection instead of dict
• loads
  • wrap json function from standard library
  • return FeatureCollection instead of dict
• dump
  • wrap json function from standard library
  • expect FeatureCollection instead of dict
• dumps
  • wrap json function from standard library
  • expect FeatureCollection instead of dict

References

• The Linked Places format (LPF)
• Python Standard Library 3.14 JSON
• RFC 7946 The GeoJSON Format