Merge pull request #52 from UDST/release-prep

Preparing v1.5.4 release

Author: smmaurer

.travis.yml

@@ -5,14 +5,13 @@ python:
   - '3.5'
   - '3.6'
   - '3.7'
-  # - '3.8' broken because PyTables binaries aren't available yet
+  - '3.8'
 
 install:
   - pip install .
   - pip install pytest-cov coveralls pycodestyle
   - pip install flask pygments  # for server component tests
   - bin/build_js_bundle.sh complete
-  - pip install numpydoc sphinx sphinx_rtd_theme  # for building docs 
   - pip list
   - pip show orca
 
@@ -22,8 +21,3 @@ script:
 
 after_success:
   - coveralls
-  - bin/build_docs.sh
-
-env:
-  global:
-    secure: DMQgAnged8quDKf3pTLG6RZVMKhrhZfYSRKaPFJrERXEOuRPJjC4QYG24pdyCV2aOQbSOiF16vSctpDmMfjLDARkhNm8FvYYCOKLkE+4ijQ4vE/uQaHsnosGS/1LOOFGjK0h2dvm4CNJqV1JUhCKeOVe/87GGY2JVBy+NJnsl70=

HISTORY.rst

@@ -1,3 +1,8 @@
+v1.5.4
+======
+
+* Support for PyToolz 0.11+
+
 v1.5.3
 ======
 

README.rst

@@ -1,40 +1,23 @@
-Orca
-====
-
-.. image:: https://img.shields.io/pypi/v/orca.svg
-    :target: https://pypi.python.org/pypi/orca/
-    :alt: PyPI Latest Version
-
-.. image:: https://travis-ci.org/UDST/orca.svg?branch=master
-    :target: https://travis-ci.org/UDST/orca
-    :alt: Build Status
-
 .. image:: https://coveralls.io/repos/UDST/orca/badge.svg?branch=master
   :target: https://coveralls.io/r/UDST/orca?branch=master
   :alt: Coverage
 
-.. image:: https://img.shields.io/pypi/wheel/orca.svg
-    :target: https://pypi.python.org/pypi/orca/
-    :alt: Wheel Status
+Orca
+====
+
+Orca is a Python library for task orchestration. It's designed for workflows like city simulation, where the data representing a model's state is so large that it needs to be managed outside of the task graph.
+
+The building blocks of a workflow are "steps", Python functions that can be assembled on the fly into linear or cyclical pipelines. Steps typically interact with a central data store that persists in memory while the pipeline runs. Derived tables and columns can be updated automatically as base data changes, and pipeline components are evaluated lazily to reduce unnecessary overhead.
 
-Orca is a pipeline orchestration tool that allows you to define dynamic data
-sources and explicitly connect them to processing functions.
-Orca has many features for working with `Pandas <http://pandas.pydata.org/>`__
-data structures, but it can be used with anything.
+Orca is used in `UrbanSim <https://github.com/udst/urbansim>`__ and other projects.
 
-Learn more in the official docs at https://udst.github.io/orca/.
+Documentation
+-------------
 
-Building the Orca UI JS Bundle
-------------------------------
+- `udst.github.io/orca/ <https://udst.github.io/orca/>`__
 
-Orca ships with a bundle of JavaScript for the server UI.
-If you've installed Orca from ``pip`` or ``conda`` you already have the
-bundle, but if you're working on Orca you might need to build it manually:
+Installation
+------------
 
-* Make sure `nodejs <https://nodejs.org/>`__ is installed.
-  (I use `Homebrew <http://brew.sh/>`__ on my Mac.)
-* Install `gulp <http://gulpjs.com/>`__: ``npm install -g gulp``
-* Change directories to ``orca/server/static``
-* Run ``npm install`` to install dependencies
-* Build the bundle: ``gulp js-build``, or
-* Watch JS files to rebuild the bundle on changes: ``gulp js-watch``
+- ``pip install orca``
+- ``conda install orca --channel conda-forge``

docs/README.md

@@ -0,0 +1,31 @@
+This folder generates the Orca online documentation, hosted at https://udst.github.io/orca/.
+
+### How it works
+
+HTML files are generated using [Sphinx](http://sphinx-doc.org) and hosted with GitHub Pages from the `gh-pages` branch of the repository. The online documentation is rendered and updated **manually**. 
+
+### Editing the documentation
+
+The files in `docs/source`, along with docstrings in the source code, determine what appears in the rendered documentation. Here's a [good tutorial](https://pythonhosted.org/an_example_pypi_project/sphinx.html) for Sphinx.
+
+### Previewing changes locally
+
+Install the copy of Orca that the documentation is meant to reflect. Install the documentation tools.
+
+```
+pip install . 
+pip install sphinx sphinx_rtd_theme numpydoc
+```
+
+Build the documentation. There should be status messages and warnings, but no errors.
+
+```
+cd docs
+sphinx-build -b html source build
+```
+
+The HTML files will show up in `docs/build/`. 
+
+### Uploading changes
+
+Clone a second copy of the repository and check out the `gh-pages` branch. Copy over the updated HTML files, commit them, and push the changes to GitHub.

docs/build/.gitignore

@@ -0,0 +1 @@
+*/*

docs/Makefile docs/source/Makefiledocs/Makefile renamed to docs/source/Makefile

@@ -51,16 +51,16 @@
 
 # General information about the project.
 project = 'Orca'
-copyright = '2019, UrbanSim Inc'
+copyright = '2020, UrbanSim Inc'
 
 # 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 = '1.5'
+version = '1.5.4'
 # The full version, including alpha/beta/rc tags.
-release = '1.5.3'
+release = '1.5.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/conf.py docs/source/conf.pydocs/conf.py renamed to docs/source/conf.py

@@ -119,19 +119,16 @@ Orca offers some conveniences for streamlining the construction of pipelines:
 Installation
 ------------
 
-Orca depends on Pandas, PyTables, and toolz (or cytoolz).
-Pandas and PyTables are included in `Anaconda <http://docs.continuum.io/anaconda/>`__.
-Toolz may be installed with `pip <https://pip.pypa.io/en/latest/index.html>`__,
-and both toolz and cytoolz are can be installed by
-`conda <http://conda.pydata.org/>`__ (if you are using Anaconda or miniconda).
+Orca requires Pandas, PyTables, and PyToolz, which will be installed automatically if they are not already present in your Python environment.
 
-With the dependencies installed, install Orca with pip::
+
+You can install Orca with pip::
 
     pip install orca
 
-Orca may also be installed with conda::
+Or with conda::
 
-    conda install -c udst orca
+    conda install orca --channel conda-forge
 
 Add the server option to include the optional server dependencies::