Release v1.0.0; add numpy-style documentation

docs/api/index.rst

@@ -0,0 +1,14 @@
+Unrasterize API
+===================
+The following classes exist to convert raster data to GeoJSON.
+
+For large raster files, the `WindowedUnrasterizer <unrasterize.WindowedUnrasterizer.html>`_ is the most memory efficient, with the caveat that it may select some points from adjacent windows that are very close together.
+
+
+Classes
+-------
+.. toctree::
+
+    unrasterize.BaseUnrasterizer
+    unrasterize.Unrasterizer
+    unrasterize.WindowedUnrasterizer

docs/api/unrasterize.BaseUnrasterizer.rst

@@ -0,0 +1,6 @@
+unrasterize.BaseUnrasterizer
+============================
+
+.. autoclass:: unrasterize.BaseUnrasterizer
+    :members:
+    :show-inheritance:

docs/api/unrasterize.Unrasterizer.rst

@@ -0,0 +1,6 @@
+unrasterize.Unrasterizer
+========================
+
+.. autoclass:: unrasterize.Unrasterizer
+    :members:
+    :show-inheritance:

docs/api/unrasterize.WindowedUnrasterizer.rst

@@ -0,0 +1,6 @@
+unrasterize.WindowedUnrasterizer
+================================
+
+.. autoclass:: unrasterize.WindowedUnrasterizer
+    :members:
+    :show-inheritance:

docs/conf.py

@@ -0,0 +1,171 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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(os.path.join(os.path.dirname(__file__), '..')))
+
+
+def _get_version():
+    with open('../unrasterize/__init__.py') as f:
+        for line in f:
+            if line.find("__version__") >= 0:
+                version = line.split("=")[1].strip()
+                version = version.strip('"')
+                version = version.strip("'")
+                continue
+    return version
+
+# -- Project information -----------------------------------------------------
+
+project = 'unrasterize'
+copyright = '2018, Brian Lewis'
+author = 'Brian Lewis'
+
+# The full version, including alpha/beta/rc tags
+release = _get_version()
+# The short X.Y version
+version = release[:3]
+
+# -- 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.autosummary',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
+]
+
+# 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'
+
+# 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 pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- 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 = 'classic'
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'unrasterizedoc'
+
+
+# -- 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, 'unrasterize.tex', 'unrasterize Documentation',
+     'Brian Lewis', '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, 'unrasterize', 'unrasterize 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, 'unrasterize', 'unrasterize Documentation',
+     author, 'unrasterize', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------

docs/contributing.rst

@@ -0,0 +1,4 @@
+Contributing
+------------
+
+View ``unrasterize`` on `GitHub <https://github.com/tetraptych/unrasterize>`_.

docs/index.rst

@@ -0,0 +1,31 @@
+===========
+Unrasterize
+===========
+
+Motivation
+==========
+Raster data formats have become increasingly popular to represent global population density (see, for example, CIESIN's `Gridded Population of the World <http://sedac.ciesin.columbia.edu/data/collection/gpw-v4>`_). But the sheer number of pixels can make working with raster data difficult for certain use cases.
+
+Enter ``unrasterize``, a lightweight package to extract representative population points from raster data. The resulting points exist in vector format (i.e., GeoJSON) and can be used by downstream applications.
+
+Sample Output
+=============
+.. image:: https://farm5.staticflickr.com/4708/39370187915_693f694b79_z_d.jpg
+
+Contents
+=================
+
+.. toctree::
+    :maxdepth: 2
+
+    usage
+    api/index
+    contributing
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/usage.rst

@@ -0,0 +1,4 @@
+Usage
+=====
+
+For an example of ``unrasterize`` in action, see `this Jupyter notebook <https://github.com/tetraptych/unrasterize/blob/master/examples/basic_unrasterizer_usage.ipynb>`_.

setup.py

@@ -8,9 +8,20 @@ def _get_long_description():
     return desc
 
 
+def _get_version():
+    with open('unrasterize/__init__.py') as f:
+        for line in f:
+            if line.find("__version__") >= 0:
+                version = line.split("=")[1].strip()
+                version = version.strip('"')
+                version = version.strip("'")
+                continue
+    return version
+
+
 setuptools.setup(
     name='unrasterize',
-    version='0.1.1',
+    version=_get_version(),
     description='A simple API for lossfully converting raster datasets to GeoJSON.',
     long_description=_get_long_description(),
     long_description_content_type='text/markdown',

unrasterize/__init__.py

@@ -21,3 +21,5 @@
 SOFTWARE.
 """
 from .classes import BaseUnrasterizer, NaiveUnrasterizer, Unrasterizer, WindowedUnrasterizer  # noqa
+
+__version__ = '1.0.0'