Merge pull request #66 from UDST/release-prep

Preparing v0.2.1 release

.travis.yml

@@ -1,45 +1,39 @@
 language: python
-sudo: false
+
 python:
-- '2.7'
-- '3.6'
+  - '2.7'
+  - '3.5'
+  - '3.6'
+  - '3.7'
+  - '3.8'
 
-matrix:
-  allow_failures:
-  - python: '3.6'  # travis hangs in demo notebook
-    env: PANDANA=">=0.4"
-  fast_finish: true
+services:
+  - xvfb  # allows matplotlib display
 
 install:
-- wget http://bit.ly/miniconda -O miniconda.sh
-- bash miniconda.sh -b -p $HOME/miniconda
-- export PATH="$HOME/miniconda/bin:$PATH"
-- hash -r
-- conda config --set always_yes yes --set changeps1 no
-- conda update -q conda
-- conda info -a
-- conda config --add channels udst
-- conda config --add channels conda-forge
-- conda create -q -n test-env python=$TRAVIS_PYTHON_VERSION pip numpy pandas pytest jupyter pycodestyle matplotlib scikit-learn pyyaml basemap basemap-data-hires pandana$PANDANA geopy osmnet
-- source activate test-env
-- conda list
-- pip install .
-
-after_success:
-- bin/build_docs.sh
+  - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
+  - bash miniconda.sh -b -p $HOME/miniconda
+  - export PATH="$HOME/miniconda/bin:$PATH"
+  - hash -r
+  - conda config --set always_yes yes --set show_channel_urls true
+  - conda update -n base conda
+  - conda config --prepend channels conda-forge
+  - conda create -n test-environment python=$TRAVIS_PYTHON_VERSION pyyaml --file requirements-dev.txt
+  - source activate test-environment
+  - conda info --all
+  - pip install .
+  - pip list
+  - pip show urbanaccess
 
 script:
-- pycodestyle urbanaccess
-- py.test
-- cd demo; jupyter nbconvert --to python simple_example.ipynb
-- cd ../urbanaccess/tests/integration; python remove_nb_magic.py -in simple_example.py -out simple_example_clean.py
-- cd ../../../demo; python simple_example_clean.py
-- cd ../urbanaccess/tests/integration; python integration_madison.py
-- python integration_sandiego.py && cd $TRAVIS_BUILD_DIR
-
-env:
-  matrix:
-  - PANDANA="=0.3"
-  - PANDANA=">=0.4"
-  global:
-    secure: SW6dfeQen1oZUYa2pr/qMdJGDK5c3tIbJsF1POLSMtgpbYaRQvogCkCd7sFXiTkxTCaNnz/eQyT2nDyUZJyDmYpntZmRthuN1zDgNk8ziDpmy/PF1bD4eshDr3MeoI4HgNYryl5qD8brEP0up0P/rvaAMoi26w4eyk0r+sO3PDVF6Jy4MwTufY4a4B4qYpi7V8yhExExytshHOEjD8C2IqEQDkwyR9oto2Gx8EpoCJEvxETG+aqLw1xj2UnXnbWND10Ni6pkeRpjAHFv4qM0i35griG2RKu9075Dubz/6UPMvpIEy581Zx5cqaSuOSUzde1L172vLTgOH31lnFXe1flHau1wI2gxOiamSdlVTAnVtL5P1aEtm1L5FjBcPlIs9rHmNGnydByX1Qe16HRLUopgAVm+jLZqWxrlesC5ax3uJ6Q3g0ZyKfmTJ5uWDeRusMVZswBT3NJc0BhkHDq7tE+3fokBfFApJcQwoXIplvRwXPkGFtKnL2IgCMTrKbDzGEYfdm/v7eV2xYe5hrEUIC9cUhkC1Ns2azAERXSgWcyM7ciFH3r1Jz9ixT+fuw9bTXibqcMjAmxdcQAW9y/rIPRJ3GMSdT7WEzYX19naGr+oyKqVMgsHFQ+wL7U5iblAGIy8VLNpE7Aa67dyG6SVAPTGzp0RouYLY9LYiRIybrI=
+  - pycodestyle urbanaccess
+  - py.test
+  - cd demo
+  - jupyter nbconvert --to python simple_example.ipynb
+  - cd ../urbanaccess/tests/integration
+  - python remove_nb_magic.py -in simple_example.py -out simple_example_clean.py
+  - cd ../../../demo
+  - python simple_example_clean.py
+  - cd ../urbanaccess/tests/integration
+  - python integration_madison.py
+  - python integration_sandiego.py

HISTORY.rst → CHANGELOG.rst

@@ -1,3 +1,11 @@
+v0.2.1
+======
+
+2020/08/28
+
+* Support for GeoPy 2.0+
+* Support for Pandas 1.0+
+
 v0.2.0
 ======
 

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+## Preparing a release:
+
+- Make a new branch for release prep
+
+- Update the version number and changelog
+  - `CHANGELOG.md`
+  - `setup.py`
+  - `urbanaccess/__init__.py`
+  - `docs/source/conf.py`
+  - `docs/source/index.rst`
+
+- Make sure all the tests are passing, and check if updates are needed to `README.md` or to the documentation
+
+- Open a pull request to the master branch to finalize it
+
+- After merging, tag the release on GitHub and follow the distribution procedures below
+
+
+## Distributing a release on PyPI (for pip installation):
+
+- Register an account at https://pypi.org, ask one of the current maintainers to add you to the project, and `pip install twine`
+
+- Check out the copy of the code you'd like to release
+
+- Run `python setup.py sdist bdist_wheel --universal`
+
+- This should create a `dist` directory containing two package files -- delete any old ones before the next step
+
+- Run `twine upload dist/*` -- this will prompt you for your pypi.org credentials
+
+- Check https://pypi.org/project/osmnet/ for the new version
+
+
+## Distributing a release on Conda Forge (for conda installation):
+
+- The [conda-forge/urbanaccess-feedstock](https://github.com/conda-forge/urbanaccess-feedstock) repository controls the Conda Forge release
+
+- Conda Forge bots usually detect new releases on PyPI and set in motion the appropriate feedstock updates, which a current maintainer will need to approve and merge
+
+- Check https://anaconda.org/conda-forge/urbanaccess for the new version (may take a few minutes for it to appear)

License.txt

@@ -1,8 +1,8 @@
                     GNU AFFERO GENERAL PUBLIC LICENSE
                        Version 3, 19 November 2007
 
- Copyright (c) 2016 UrbanSim Inc.
- Copyright (c) 2015-2016 Samuel D. Blanchard
+ Copyright (c) 2020 UrbanSim Inc.
+ Copyright (c) 2020 Samuel D. Blanchard
 
  Everyone is permitted to copy and distribute verbatim copies
  of this license document, but changing it is not allowed.

MANIFEST.in

@@ -0,0 +1,4 @@
+# files to include in the source distribution on pypi (setup and README are included automatically)
+
+include CHANGELOG.rst
+include License.txt

README.rst

@@ -55,13 +55,6 @@ To cite this tool and for a complete description of the UrbanAccess methodology
 
 For other related literature see `here <https://udst.github.io/urbanaccess/introduction.html#citation-and-academic-literature>`__.
 
-Current status
---------------
-
-*Forthcoming improvements:*
-
-- Unit tests
-
 Reporting bugs
 --------------
 
@@ -82,15 +75,15 @@ Install the latest release
 
 conda
 ~~~~~~
-UrbanAccess is available on conda and can be installed with::
+UrbanAccess is available on Conda Forge and can be installed with::
 
-    conda install -c udst urbanaccess
+    conda install urbanaccess -c conda-forge
 
 pip
 ~~~~~~
 UrbanAccess is available on PyPI and can be installed with::
 
-    pip install -U urbanaccess
+    pip install urbanaccess
 
 Development Installation
 ------------------------