Initial commit.

.gitignore

@@ -0,0 +1,5 @@
+*.pyc
+.coverage
+dist
+pypg.egg-info
+doc/build

MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include MANIFEST.in
+include README.rst
+recursive-include plpygis *

Makefile

@@ -0,0 +1,10 @@
+.PHONY: test
+
+test:
+	nosetests --verbose --with-cover --cover-erase --cover-package=plpygis
+
+clean:
+	find . -name "*.pyc" -print0 | xargs -0 rm -rf
+	find . -name "__pycache__" -print0 | xargs -0 rm -rf
+	rm -rf dist plpygis.egg-info
+	rm -rf doc/build

README.rst

@@ -0,0 +1,28 @@
+=======
+plpygis
+=======
+
+``plpygis`` is a Python conveter to and from the PostGIS ``geometry`` type, WKT, EWKT, WKB, EWKB, GeoJSON and Shapely geometries, or using ``__geo_interface__``. ``plpygis`` is intended for use in PL/Python functions.
+
+Basic usage
+===========
+
+The ``Geometry`` class can be used to convert to and from PostGIS geometries. The following example will take a PostGIS multipolygon geometry named ``geom`` and find its largest component polygon.
+
+``Geometry()`` can convert direclty a Postigs ``geometry`` that has been passed as a parameter to a PL/Python function. A ``Geometry`` that is returned from the PL/Python function will automatically be converted back to a PostGIS ``geometry``.
+
+.. code-block:: postgres
+ 
+    CREATE OR REPLACE FUNCTION largest_poly(geom geometry)
+      RETURNS geometry 
+    AS $$
+      from plpygis import Geometry
+      polygons = Geometry(geom)
+      if polygons.type == 'Polygon':
+          return polygons
+      elif polygons.type == 'MultiPolygon':
+          largest = max(polygons.shapely, key=lambda polygon: polygon.area)
+          return Geometry.from_shapely(largest)
+      else:
+          return None
+    $$ LANGUAGE plpythonu;

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = 
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = plpygis
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/source/conf.py

@@ -0,0 +1,163 @@
+# -*- coding: utf-8 -*-
+#
+# plpygis documentation build configuration file, created by
+# sphinx-quickstart on Wed Jul  5 19:28:02 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+import plpygis
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.githubpages']
+
+autoclass_content = "both"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'plpygis'
+copyright = u'2017, Benjamin Trigona-Harany'
+author = u'Benjamin Trigona-Harany'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = plpygis.__version__
+# The full version, including alpha/beta/rc tags.
+release = version
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'plpygisdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'plpygis.tex', u'plpygis Documentation',
+     u'Benjamin Trigona-Harany', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'plpygis', u'plpygis Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'plpygis', u'plpygis Documentation',
+     author, 'plpygis', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

doc/source/index.rst

@@ -0,0 +1,17 @@
+.. plpygis documentation master file, created by
+   sphinx-quickstart on Wed Jul  5 19:28:02 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+###################################
+Welcome to plpygis's documentation!
+###################################
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   usage
+   plpython
+   plpygis

doc/source/installation.rst

@@ -0,0 +1,13 @@
+Installation
+============
+
+plpygis may be installed from PyPi.
+
+.. code-block:: console
+
+   $ pip install plpygis
+
+It is recommended that plpygis is installed into the system installation of Python or it may not be available in PL/Python functions.
+
+The package sources are available at https://github.com/bosth/plpygis.
+

doc/source/plpygis.rst

@@ -0,0 +1,18 @@
+plpygis package
+===============
+
+.. automodule:: plpygis
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+plpygis\.geometry module
+------------------------
+
+.. automodule:: plpygis.geometry
+    :members:
+    :undoc-members:
+    :show-inheritance: