numpydoc

src/pyhaloxml/HaloXML.py

@@ -2,6 +2,23 @@
 A package for parsing .annotations files from Halo.
 
 It can load .annotation files and store them as .geojson. The geojson will be QuPath compatible.
+
+Examples
+--------
+Converting an annotations file to geojson:
+
+>>> from pyhaloxml import HaloXML
+>>> hx = HaloXML()
+>>> hx.load(r'c:\\test.annotations')
+>>> hx.matchnegative()
+>>> hx.to_geojson(r'c:\\test.geojson')
+
+Using the contextmanager to do the same thing:
+
+>>> from pyhaloxml import HaloXMLFile
+>>> with HaloXML(r'c:\\test.annotations') as hx:
+>>>     hx.matchnegative()
+>>>     hx.to_geojson(r'c:\\test.geojson')
 """
 
 import io