.. papotch documentation master file, created by
   sphinx-quickstart on Sat Jun  6 21:23:21 2026.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

papotch
=====================

Trying to build a user-friendly API to process spatial data around `polars(_st) DataFrames`_.

.. _polars(_st) DataFrames: https://github.com/Oreilles/polars-st

Installation
=====================

From Pypi :

.. code-block::

   pip install papotch


Quickstart
=====================

`papotch` has 2 objects for now : `Reader` and `Data`.

.. code-block:: python

   from papotch import Reader
   
   # Create the Reader object with the uri.
   r = Reader("path/to/data.shp")

   # Extract data.
   d = r.extract()

   # Buffer, calculate the resulting area, then the bounding coordinates.
   _ = d.buffer(distance=2).area(column_name="calc_area").bounds()

   # Write to a postgres database
   d.write("PG:service=my_service", layer="my_layer")
   
.. toctree::
   :hidden:

   src/api