Skip to content

Picterra/picterra-python

Repository files navigation

Picterra logo

Picterra Python API Client

Tests Documentation Status PyPI - Version

Easily integrate state-of-the-art machine learning models in your app

from picterra import APIClient

# Replace this with the id of one of your detectors
detector_id = 'd552605b-6972-4a68-8d51-91e6cb531c24'

# Set the PICTERRA_API_KEY environment variable to define your API key
client = APIClient()
print('Uploading raster...')
raster_id = client.upload_raster('data/raster1.tif', name='a nice raster')
print('Upload finished, starting detector...')
result_id = client.run_detector(detector_id, raster_id)
client.download_result_to_feature_collection(result_id, 'result.geojson')
print('Detection finished, results are in result.geojson')

Installation

pip install picterra

See the examples folder for examples.

API Reference and User Guide available on Read the Docs

Read the Docs

Development

In order to test locally, run:

python setup.py test

Release process

  1. Bump the version number in setup.py
  2. Manually run the publish to testpypi workflow
  3. Check the publication result on testpypi
  4. Create a release through github
  5. The 'publish to pypi' workflow should automatically run
  6. Updated package should be available on pypi